Fix semantic markup of table of contents #1180
Merged
Conversation
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
<nav> is a more appropriate tag for a table of content elements. And the additional aria-label helps screen reader users and search engines figure out what it's about.
✅ Deploy Preview for bitcoin-design-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the semantic markup and accessibility of table of contents elements across the documentation by replacing
elements with elements and adding appropriate aria-labels.
- Replaced generic container elements with semantic tags in multiple guide pages.
- Added aria-labels for improved screen reader support.
Reviewed Changes
Copilot reviewed 36 out of 36 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| guide/savings-wallet/time-based-recovery.md | Updated table of contents container to with aria-label. |
| guide/resources/design-research.md | Updated table of contents container to with aria-label. |
| guide/multiple-wallets.md | Updated table of contents container to with aria-label. |
| guide/inheritance-wallet/wallet-creation.md | Updated table of contents container to with aria-label. |
| guide/inheritance-wallet/succession.md | Updated table of contents container to with aria-label. |
| guide/inheritance-wallet/overview.md | Updated table of contents container to with aria-label. |
| guide/inheritance-wallet/onboarding-cosigners.md | Updated table of contents container to with aria-label. |
| guide/inheritance-wallet/making-changes.md | Updated table of contents container to with aria-label. |
| guide/inheritance-wallet/backup.md | Updated table of contents container to with aria-label. |
| guide/how-it-works/wallet-privacy.md | Updated table of contents container to with aria-label. |
| guide/how-it-works/stabilizing-bitcoin-value.md | Updated table of contents container to with aria-label. |
| guide/how-it-works/silent-payments.md | Updated table of contents container to with aria-label. |
| guide/how-it-works/sign-in-with-bitcoin.md | Updated table of contents container to with aria-label. |
| guide/how-it-works/liquidity.md | Updated table of contents container to with aria-label. |
| guide/how-it-works/human-readable-addresses.md | Updated table of contents container to with aria-label. |
| guide/how-it-works/ecash/design-best-practices.md | Updated table of contents container to with aria-label. |
| guide/glossary/index.md | Updated table of contents container to with aria-label. |
| guide/glossary/address.md | Updated table of contents container to with aria-label. |
| guide/getting-started/principles.md | Updated table of contents container to with aria-label. |
| guide/designing-products/user-personas.md | Updated table of contents container to with aria-label. |
| guide/designing-products/personal-finance.md | Updated table of contents container to with aria-label. |
| guide/designing-products/common-user-flows.md | Updated table of contents container to with aria-label. |
| guide/daily-spending-wallet/settings.md | Updated table of contents container to with aria-label. |
| guide/daily-spending-wallet/sending.md | Updated table of contents container to with aria-label. |
| guide/daily-spending-wallet/security.md | Updated table of contents container to with aria-label. |
| guide/daily-spending-wallet/requesting/requesting.md | Updated table of contents container to with aria-label. |
| guide/daily-spending-wallet/requesting/receiving.md | Updated table of contents container to with aria-label. |
| guide/daily-spending-wallet/privacy.md | Updated table of contents container to with aria-label. |
| guide/daily-spending-wallet/landing-page.md | Updated table of contents container to with aria-label. |
| guide/daily-spending-wallet/first-use.md | Updated table of contents container to with aria-label. |
| guide/daily-spending-wallet/contacts.md | Updated table of contents container to with aria-label. |
| guide/contribute/formatting/media.md | Updated table of contents container to with aria-label. |
| guide/contribute/formatting/index.md | Updated table of contents container to with aria-label. |
| guide/contribute/case-studies.md | Updated table of contents container to with aria-label. |
| guide/case-studies/saving-satoshi.md | Updated table of contents container to with aria-label. |
| guide/case-studies/payjoin.md | Updated table of contents container to with aria-label. |
swedishfrenchpress
approved these changes
Jun 25, 2025
Collaborator
swedishfrenchpress
left a comment
swedishfrenchpress
left a comment
There was a problem hiding this comment.
ACK. No breaking changes. Helpful addition.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Replacing the
divused for table of content elements withnavtags (info), as well as adding aria-labels. These two changes help screen readers and search engines correctly identify the elements as navigation and table of contents for the page.Something that is not 100% ideal is that the automated table of contents creates unordered lists (
ul). Ordered lists (ol) would be more appropriate, since the order of the table of contents always matches the order of the page content. But that is a built-in jekyll/markdown thing and can't be changed AFAICT.There are no visible changes, it's all under-the-hood.