Skip to content
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

Reference doc: table of contents within a chapter #40087

Closed
SimonSapin opened this issue Feb 25, 2017 · 3 comments
Closed

Reference doc: table of contents within a chapter #40087

SimonSapin opened this issue Feb 25, 2017 · 3 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools

Comments

@SimonSapin
Copy link
Contributor

It looks like https://doc.rust-lang.org/nightly/reference.html hasn’t been updated yet as of this writing, but in my local copy of the docs reference.html says “We've split up the reference into chapters. Please find it at its new home here.” with a link to reference/index.html.

This new format has a side bar with a table of content, but that ToC has coarser granularity than it used to. As far as I can tell, it has a link for each “chapter” (part of the book that requires navigation to another URL), but I can’t find a ToC for sections within a chapter. reference/expressions.html for example has many sub-sections, to a per-chapter ToC would help a lot.

This is probably a feature request for tool that generates this kind of documentation, but I’m not sure what it is. I’ve vaguely heard of rustboot and mdbook, is this one on these? Are they related? Which issue tracker should be used?

CC @steveklabnik

@frewsxcv
Copy link
Member

Relevant PR: #39855

@steveklabnik
Copy link
Member

It's mdbook, and yes, it would have to be filed there, I think.

Soon, we'll be pulling the reference out into its own repo, so this bug would be filed there.

@steveklabnik steveklabnik added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools and removed A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Mar 10, 2017
@steveklabnik
Copy link
Member

moved rust-lang/reference#15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools
Projects
None yet
Development

No branches or pull requests

3 participants