rust-lang / rust-lang/rustc-dev-guide
The explanation of Rustdoc internals is partially outdated
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
I've been digging around the rustdoc internals docs and realized that some of the descriptions are outdated. I'm specifically mentioning about the ## From clean to crate chapter. For example, there's no longer html/render.rs file; it's been renamed to html/render/mod.rs as of 6a4396b. Moreover, the renamed file a function called run(). I don't know which function is the current entrypoint.
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 rustdoc internals documentation, especially the “From clean to crate” chapter, against the current rustdoc source. Start with html/render/mod.rs and determine the current entry point, noting that the issue identifies run() as a function there. Done means the chapter no longer references html/render.rs and accurately describes the current flow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100