Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
workingjubilee opened this issue Sep 6, 2020 · 0 comments
Open

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

workingjubilee opened this issue Sep 6, 2020 · 0 comments
Labels
A-meta Area: meta, about rustc or rustc-dev-guide itself E-medium Difficulty: might require some prior knowledge or code reading WG-rustc-dev-guide Working group: rustc-dev-guide

Comments

@workingjubilee
Copy link
Member

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.

@jyn514 jyn514 added S-blocked Status: this PR is blocked waiting for something E-easy Difficulty: might be a good place for a beginner and removed S-blocked Status: this PR is blocked waiting for something labels Sep 6, 2020
@jyn514 jyn514 mentioned this issue Jan 9, 2021
4 tasks
@jieyouxu jieyouxu added A-meta Area: meta, about rustc or rustc-dev-guide itself WG-rustc-dev-guide Working group: rustc-dev-guide E-medium Difficulty: might require some prior knowledge or code reading and removed E-easy Difficulty: might be a good place for a beginner labels Nov 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-meta Area: meta, about rustc or rustc-dev-guide itself E-medium Difficulty: might require some prior knowledge or code reading WG-rustc-dev-guide Working group: rustc-dev-guide
Projects
None yet
Development

No branches or pull requests

3 participants