Make README more complete and easier to follow - #2973
Merged
Conversation
rustbot
added
the
S-waiting-on-review
Member
Author
|
ah hm, a lot of this is duplicated from https://rustc-dev-guide.rust-lang.org/contributing.html#contributing-to-rustc-dev-guide, maybe we should just link there. |
- Organize by "About" -> "Contributing" -> "Editing" -> "Maintaining" rather than mixing sections - Deduplicate a few lines into the guide itself - Recommend `mdbook serve` over `mdbook build` - Document `mdbook` layout and link to the upstream docs - Document sembr and that relative links must use `.md` extensions - Add a section on testing the tools in `ci/`
jyn514
force-pushed
the
reorganize-readme
branch
from
August 17, 2026 07:23
3b38aa4 to
123c192
Compare
Member
Author
|
i think this is a clear improvement so i'm just going to merge it. |
rustbot
removed
the
S-waiting-on-review
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
mdbook serveovermdbook buildmdbooklayout and link to the upstream docs.mdextensionsci/Disclosure: I used an LLM to suggest what would be most helpful to put in the README. I wrote all the text myself.
r? rustc-dev-guide