rust-lang / rust-lang/rustc-dev-guide
New Diagrams in the guide
Open
Nobody has claimed this yet.
A-visualizations
C-enhancement
E-hard
T-compiler
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
It would be great to add diagrams to the guide. There have been a few discussions on zulip and some work by @chrissimpkins and @LeSeulArtichaut
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 the linked Zulip discussions and HackMD proposal for the Graphviz and Mermaid approaches. Identify which guide sections need diagrams and confirm the format and scope with maintainers. Done means the agreed diagrams are added to the guide and render correctly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100