rust-lang / rust-lang/rustc-dev-guide
Explain the technical parts of the Walkthrough somewhere
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
Was reading this https://rust-lang.github.io/rustc-guide/walkthrough.html and I thought that it could be very nice if we can explain the actual code of the PR. It seems like a feature that touches a lot of parts of the compiler so it may be a good idea to explain things there or later in the guide but using this same example.
cc @mark-i-m
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 with the existing Walkthrough at rust-lang.github.io/rustc-guide/walkthrough.html and identify the example or PR whose technical implementation should be explained. Map which compiler areas it touches before proposing guide sections. Done means the same example has a clear explanation of its relevant code and compiler interactions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100