chore(docs): Update README

Open
#101 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start with README and compare its table of contents, links, and newcomer setup guidance with the current repository, especially CONTRIBUTING.md. Remove stale content, repair broken links such as “What’s New,” and make the CONTRIBUTING.md link and intended audience obvious; done means the README is current and newcomers can follow it without avoidable issues.

Written by the indexing model from the issue text.

Description

Documentation Userale

Copied from https://github.com/apache/flagon-useralejs/issues/505

Problem

Our README is stale, has broken links (ex: "What's New" in the TOC), and is not sufficient for newcomers to immediately get off the ground without running into issues.

Solution

Remove stale parts
Update links
Make link to CONTRIBUTING.md and who should go there obvious
Dominant language
Jupyter Notebook
Stars
30
Forks
15
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/flagon

All issues in apache/flagon

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.