Skip to content

rustdoc: Restructure all rustdoc-related chapters #2459

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
fmease opened this issue Jun 7, 2025 · 0 comments
Open

rustdoc: Restructure all rustdoc-related chapters #2459

fmease opened this issue Jun 7, 2025 · 0 comments
Labels
C-cleanup Category: cleanups C-enhancement Category: enhancement T-rustdoc Relevant to rustdoc team

Comments

@fmease
Copy link
Member

fmease commented Jun 7, 2025

  1. Chapters about rustdoc's test suites shouldn't live in rustdoc-internals/ but in tests/ where all other test-related things are located.
  2. The split between "rustdoc overview" and "rustdoc internals" is weird, "I don't know where to put things".
  3. The "rustdoc overview" (in "How to build in run the compiler") contains a lot of things, a lot of things. It's not really an overview / a succinct but complete intro on how to get things going.
  4. Then we have "internals" as well which IIRC duplicates some of the info given in the "overview" / mentions things that should be in an "overview" idk

Disclaimer: My memory is slightly hazy, these were my thoughts / mere feelings from ~1 week ago when I worked on #2298. I prolly didn't read everything as carefully as I could because I worked on other things but I remember being slightly frustrated / confused with the overall structure of rustdoc-related information etc.

I know this isn't very actionable right now, these comments come straight out of my mind, unprocessed. I'll revisit this at some point.

@fmease fmease added C-enhancement Category: enhancement C-cleanup Category: cleanups T-rustdoc Relevant to rustdoc team labels Jun 7, 2025
@rustbot rustbot added the needs-triage This issue needs triage to classify its nature and status label Jun 7, 2025
@fmease fmease removed the needs-triage This issue needs triage to classify its nature and status label Jun 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-cleanup Category: cleanups C-enhancement Category: enhancement T-rustdoc Relevant to rustdoc team
Projects
None yet
Development

No branches or pull requests

2 participants