Revise main README.md
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.2k
- Forks
- 76
- PR merge metrics
- No merged PRs in 30d
Description
The README.md for Roast is very large and parts are outdated. We should change this to a summary, basic usage, and contribution instructions. Documentation should be provided in a better organized format (possibly a docs/ directory with something like gitbook or docusaurus, or project wiki).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing README.md and identifying its outdated or oversized sections. Compare the current usage and contribution guidance with the project’s present state, then determine whether a docs/ directory, GitBook, Docusaurus, or project wiki is appropriate. Done means the README is a concise summary with basic usage and contribution instructions, with reorganized documentation available in the chosen format.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100