Document Docs.rs architecture for contributors
Open
Nobody has claimed this yet.
A-newcomer-roadblock
C-enhancement
E-medium
P-medium
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 232
- Avg merge
- 11h 35m
- Merged PRs (30d)
- 60
Description
Crates.io does a pretty good job of this with their docs folder and I think that it'd be really worth it to put down the hows and whys of docs.rs so that incoming contributors can get a jump start in understanding the codebase
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
Review the crates.io docs folder linked in the issue as a reference, then map the docs.rs codebase to identify the architecture and contributors' entry points. Document the relevant hows and whys so incoming contributors can understand the project and get started; completion is a contributor-focused architecture guide covering the codebase.
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
- Mostly clear
- Newbie friendliness
- 38/100