Integrate examples into documentation
Open
Nobody has claimed this yet.
C-enhancement
E-help-wanted
- Dominant language
- Rust
- Stars
- 3.2k
- Forks
- 265
- Avg merge
- 2h 42m
- Merged PRs (30d)
- 4
Description
Benefits
- Users have one place to look
- We can add explanatory text around them with intra-doc links
- They are versioned with the API
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 locating the repository's examples and documentation entry points; the issue does not name specific files or tests. Determine how examples can be placed with explanatory text and intra-doc links, then verify that they are versioned alongside the API and that users have one documentation location to consult.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100