[Usability] Clean-up/Read-through all of our documentation and clean-up/fix incorrect artifacts
Open
Nobody has claimed this yet.
Priority-P1
Type-clean up
- Dominant language
- Python
- Stars
- 502
- Forks
- 58
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 57
Description
Missing & incorrect docs in v2: omnidreams README.md
This applies to most README files in the repo.
Additionally, .rst files are now mostly outdated
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 with the v2 omnidreams README.md, then review the repository's other README files and .rst files for missing, incorrect, or outdated content. Done means the documentation has been read through and the identified artifacts are corrected across the affected files.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100