feat: Add a Chapter on Accessibility in the Rustdoc book#151106
Open
JayanAXHF wants to merge 9 commits intorust-lang:mainfrom
Open
feat: Add a Chapter on Accessibility in the Rustdoc book#151106JayanAXHF wants to merge 9 commits intorust-lang:mainfrom
JayanAXHF wants to merge 9 commits intorust-lang:mainfrom
Conversation
rustbot
added
S-waiting-on-author
JayanAXHF
force-pushed
the
rustdoc_accessibility
branch
from
8ded36a to
07d2971
Compare
rustbot
added
the
S-waiting-on-review
rustbot
removed
the
S-waiting-on-author
Collaborator
|
r? @notriddle rustbot has assigned @notriddle. Use |
This comment has been minimized.
This comment has been minimized.
Member
Author
|
@GuillaumeGomez The chapter is (imo) complete and ready for review! |
Member
Author
|
@rustbot r? GuillaumeGomez |
JayanAXHF
added
A-docs
notriddle
reviewed
Jan 26, 2026
Co-authored-by: Michael Howell <michael@notriddle.com>
Member
Author
|
@rustbot ready |
Collaborator
| 1. `rustdoc` only uses JavaScript to make your experience better, but `rustdoc` works perfectly well without it, meaning that most interactive features should work well without JavaScript. This ensures that no hidden scripts or interactive elements mess with screen readers and other accessibility tools. | ||
| 2. `rustdoc` uses semantic HTML elements wherever possible. | ||
| 1. We use `<details>` instead of checkboxes so text can still be searched in hidden and collapsed content. | ||
| 2. We use the `title` attribute to make your experience better, but `rustdoc` is perfectly usable without them. The **`title`** global attribute contains text representing advisory information related to the element it belongs to.[^4] |
Member
There was a problem hiding this comment.
Suggested change
| 2. We use the `title` attribute to make your experience better, but `rustdoc` is perfectly usable without them. The **`title`** global attribute contains text representing advisory information related to the element it belongs to.[^4] | |
| 2. We use the `title` attribute on HTML elements. The **`title`** attribute contains text representing advisory information related to the element it belongs to.[^4] |
Also it's the only attribute/tag you explain.
Member
Author
There was a problem hiding this comment.
Yeah I need to expand on this a bit more, haven't gotten enough time though rn due to exams and all
Contributor
There was a problem hiding this comment.
Isn't the whole point of this note to elaborate that title should never be used for vital functionality?
Member
Author
There was a problem hiding this comment.
Yeah iirc that's why it's there. I should make that clearer
| 1. We use `<details>` instead of checkboxes so text can still be searched in hidden and collapsed content. | ||
| 2. We use the `title` attribute to make your experience better, but `rustdoc` is perfectly usable without them. The **`title`** global attribute contains text representing advisory information related to the element it belongs to.[^4] | ||
| 3. All necessary elements are annotated by aria labels, to ensure that all elements have an accessible name[^4] for screen reader compatibility. | ||
| 4. `rustdoc` has expansive support for keyboard navigation, such as keybinds for searching, focusing and interacting with the UI. |
Member
There was a problem hiding this comment.
I don't see how it's related to accessibility.
Member
Author
There was a problem hiding this comment.
The first point? Well some screenreaders have trouble with collapsible sections, and the recommended way to have collapsibles is using the semantic tags. Some sites just use js and random tags for that, so I though it'd be worth mentioning
GuillaumeGomez
requested changes
Feb 7, 2026
rustbot
added
S-waiting-on-author
Co-authored-by: Guillaume Gomez <guillaume1.gomez@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a chapter on the accessibility of rustdoc, the accessible practices followed by rustdoc, WCAG 2.1 compliance, and known issues with rustdoc w.r.t. accessibility. Please see #151007 for more information.
Zulip Discussion: #t-rustdoc > A Proposal to Make Rustdoc More Accessible
cc: @GuillaumeGomez