rust-lang / rust-lang/rustc-dev-guide

Provide "how to use" for each section of rustc-dev-guide

Open
#853 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-meta E-medium WG-rustc-dev-guide
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

Any resource of any considerable length or value inevitably hits this point of recursion: it must instruct the user on how to use it. Thanks to the excellent work of the rustc-dev-guide contributors, the guide has not only hit this point of being so value it has more information than can simply be skimmed, it has lapped it. Now each section has plenty of information! ...enough that it, alas, requires its own organizational overhead, such as an introductory preview and sub-Table-of-Contents-like arrangement.

Content may need to be rearranged to make this particularly useful,
e.g. organizing the Linux, Mac, and Windows sections of "Building and debugging rustc".
"There isn't a distinct Linux and Mac section of 'Building and debugging rustc' tho'? Just the start and then Windows."
Exactly.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the rustc-dev-guide sections and the current organization of “Building and debugging rustc,” including its Linux, Mac, and Windows coverage. Identify how each section could provide an introductory preview and a sub-Table of Contents, then determine which content needs rearranging; the work is done when the guide’s sections have consistent navigation and clearer organization.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.