Change main navigation to an ARIA Navigation landmark
Nobody has claimed this yet.
- Dominant language
- Nunjucks
- Stars
- 547
- Forks
- 726
- Avg merge
- 2h 23m
- Merged PRs (30d)
- 3
Description
ARIA landmarks can make it easier for screen reader users to navigate to major parts of a page. Currently the only navigation landmark on pages is the Breadcrumbs.
Change <div id="skip-nav"> to <nav id="skip-nav">
You could give it a name, like how the Breadcrumbs landmark is named, but I think an unnamed Navigation landmark will be (correctly) assumed to be the main nav when "Breadcrumbs" is the only other nav landmark.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in src/_includes/components/docs-toc.njk at the referenced line and inspect the surrounding skip-navigation markup and the existing Breadcrumbs landmark. Change the skip-nav wrapper to the requested navigation element, then verify that the generated pages retain the same navigation content and include the expected ARIA landmark.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- accessibility
- Issue type
- Feature
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 90/100