chore(docs): Update README
- Dominant language
- Jupyter Notebook
- Stars
- 30
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
No contributing guide indexed for this repository
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.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100