Skip to content

Conversation

weihanglo
Copy link
Member

What does this PR try to resolve?

We've already saw rustc and rustc-dev-guide adopting this. Since The Cargo Book is more like a reference manual, so would largely benefit from the toc on page.

Ref: rust-lang/rust#140113.

How to test and review this PR?

mdbook serve src/doc

I didn't make it for contrib doc because that one doesn't have long one page docs, and I hope the feature will eventually upstream into mdbook 😆.

Some screenshots

image
image
image
image

We've already saw rustc and rustc-dev-guide adopting this.
Since The Cargo Book is more like a reference manual,
so would largely benefit from the toc on page.

Ref: <rust-lang/rust#140113>.
@rustbot
Copy link
Collaborator

rustbot commented Aug 17, 2025

r? @epage

rustbot has assigned @epage.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 17, 2025
@weihanglo
Copy link
Member Author

r? ehuss

as you're the mdbook maintainer :)

@rustbot rustbot assigned ehuss and unassigned epage Aug 17, 2025
@weihanglo
Copy link
Member Author

Also during this I found in Semver compatibility chapter some sections have smaller headers. Not sure if it is intentional.

image

@ehuss
Copy link
Contributor

ehuss commented Sep 11, 2025

mdbook has added native navigation for in-page sections. I was wondering if we could hold off on this and wait until we transition to the new version?

@weihanglo
Copy link
Member Author

Totally. Looking forwards to it!

@weihanglo weihanglo marked this pull request as draft September 12, 2025 00:24
@rustbot rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 12, 2025
@weihanglo
Copy link
Member Author

Or just close this

@weihanglo weihanglo closed this Sep 12, 2025
@weihanglo weihanglo deleted the toc branch September 12, 2025 00:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-documenting-cargo-itself Area: Cargo's documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants