Skip to content

Replace manual notes in documentation with admonitions #19357

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.

Sign up for GitHub

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

Jump to bottom
Draft
anoadragon453 wants to merge 8 commits into
base: develop
Choose a base branch
from
Draft

Replace manual notes in documentation with admonitions #19357

anoadragon453 wants to merge 8 commits into from

Conversation

@anoadragon453
Copy link
Member

@anoadragon453 anoadragon453 commented Jan 7, 2026

As they're generally prettier. They also render in GitHub's markdown renderer!

Requires #19356

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Code style is correct (run the linters)

@anoadragon453
Bump mdbook from 0.4.17 -> 0.5.2
f481991
@anoadragon453
The multilingual option was removed in 0.5, and never had any effect
8735831 
See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#05-migration-guide
@anoadragon453
Remove custom table-of-contents mdbook plugin
8d4ff35 
We can now rely on the default functionality built into mdbook for this.
@anoadragon453
Port new changes to mdbook default theme to our copy
4c807ca 
The custom theme is still needed for the version picker. Technically we
could add this HTML in the version-picker.js, but there's no guarantee
that the HTML IDs etc. wouldn't change out from under us.

We also no longer need the next/prev hiding plugin, as the original
point of it was to prevent those UI elements from interfering with our
custom TOC.
@anoadragon453
Remove the remove-nav-buttons plugin
823338f 
No longer needed as the original purpose was to stop them from interfering with the TOC on desktop.
@anoadragon453
Account for renamed list in mdbook JSON output
20b3842 
"sections" was renamed to "items" in rust-lang/mdBook#2813
@anoadragon453
newsfile
e660cf2
@anoadragon453
Replace manual notes in documentation with admonitions
d3045cd 
As they're generally prettier.

Requires #19356
Base automatically changed from anoa/update_mdbook to develop January 7, 2026 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@anoadragon453