Disambiguate the permalinks so that they do not all have the same programmatic name
ChrisXKeroack opened this issue · comments
Describe the bug
Because all permalinks have the same programmatic name, It will take extra time for e.g., screenreader user to get context on which permalink goes to what, and lack of unique / short name will make working with these links awkward for e.g., voice input
To Reproduce
Steps to reproduce the behavior:
- start a screenreader
- https://openfl.readthedocs.io/en/latest/index.html
- navigate through interactive elements in the page content
notice: all permalinks are described the same
Expected behavior
Each permalink should also include the text of the heading next to it, so that when a screenreader e.g. uses common feature of screenreader to get a list of all links, the link names will all be unique
Screenshots
Desktop:
This issue is not OS or browser specific, but for tracking purposes, testing was done on Win11, in Edge Version 114.0.1823.58 (Official build) (64-bit), and the screenreader in use was the common 3rd party screenreader NVDA (http://www.nvaccess.org).
Smartphone:
This issue is not device, OS, or browser specific.
Additional context
This is an accessibility issue, please annotate this bug with the 'accessibility' label.
This is an issue with the Read The Docs platform.