Add links to examples folder
Open
Nobody has claimed this yet.
E-easy
P-medium
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 232
- Avg merge
- 11h 35m
- Merged PRs (30d)
- 60
Description
Not sure if it is possible, but as examples are complimentary to documentation, it would be nice if docs.rs could provide links to examples in the repo examples directory (even perhaps render them?).
Contributor guide
No contributing guide indexed for this repository
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 how docs.rs presents crate documentation and how the repository's examples folder is currently handled. Define whether the completed work should link to or render those examples, then verify the generated documentation exposes the examples in the agreed form.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100