fix: improve sidebar accessibility structure (#8429)
This PR addresses issue #8429 by improving the accessibility structure of the documentation sidebar.
Changes Made:
- Replaced the outer
<div>/<aside>with a semantic<nav aria-label="docs sidebar"> - Applied
aria-hidden="true"to the logo when not intended to be focusable or read - Cleaned up markup to match accessibility expectations
#Why this is still useful:
Although NVDA did not read the logo before the fix, the original markup was semantically incorrect:
- The outer
<aside>was unnecessary and could cause duplicate landmark announcements in some screen readers - The logo lacked explicit
aria-hidden, leaving its behaviour inconsistent across assistive tech
This change makes the sidebar:
- More semantically correct
- More predictable across screen readers
- Closer to WAI-ARIA and a11y best practices
Tested locally with NVDA and DOM inspection.
Hi @LassadBoubarma!
Thank you for your pull request and welcome to our community.
Action Required
In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.
Process
In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.
Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.
If you have received this in error or have any questions, please contact us at [email protected]. Thanks!
⚡️ Lighthouse report for the deploy preview of this PR
| URL | Performance | Accessibility | Best Practices | SEO | Report |
|---|---|---|---|---|---|
| / | 🟠 70 | 🟢 98 | 🟢 100 | 🟢 100 | Report |
| /docs/installation | 🟠 50 | 🟢 97 | 🟢 100 | 🟢 100 | Report |
| /docs/category/getting-started | 🟠 71 | 🟢 100 | 🟢 100 | 🟠 86 | Report |
| /blog | 🟠 63 | 🟢 96 | 🟢 100 | 🟠 86 | Report |
| /blog/preparing-your-site-for-docusaurus-v3 | 🟠 62 | 🟢 92 | 🟢 100 | 🟢 100 | Report |
| /blog/tags/release | 🟠 63 | 🟢 96 | 🟢 100 | 🟠 86 | Report |
| /blog/tags | 🟠 73 | 🟢 100 | 🟢 100 | 🟠 86 | Report |
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!