[Documentation] Give permalinks more meaningful accessible names
Open
Nobody has claimed this yet.
needs-triage
openui-site
- Dominant language
- MDX
- Stars
- 4.5k
- Forks
- 226
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 4
Description
While chatting about documentation, we noticed that the permalinks in heading titles are labeled with an aria-label="Anchor". These should be renamed/restructured so that the titles are more meaningful to assistive tech users, e.g. when navigating the content by links.
Example: inspect headings on https://open-ui.org/charter
Contributor guide
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
Inspect how heading permalinks are generated across the documentation pages, using the charter page as the example. Verify the resulting accessible names when navigating headings by links, and consider the work done when the names identify their associated headings rather than being announced as “Anchor”.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100