Docs don't make it obvious how the pieces connect together
Open
Nobody has claimed this yet.
C-bug
- Dominant language
- Rust
- Stars
- 3.2k
- Forks
- 265
- Avg merge
- 2h 42m
- Merged PRs (30d)
- 4
Description
There is no top-level example, core types are re-exported, rather than inline in the top-level docs, and many items are in the top-level without being clear when to use them without digging into all of the documentation.
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 the top-level documentation and how core types are currently re-exported. Add a top-level example, clarify when to use the top-level items, and make the connections between the pieces obvious without requiring readers to search through all documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100