Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disambiguate the permalinks so that they do not all have the same programmatic name #851

Open
ChrisXKeroack opened this issue Jun 30, 2023 · 1 comment
Labels
accessibility Improving accessibility of framework good first issue Good for newcomers

Comments

@ChrisXKeroack
Copy link

ChrisXKeroack commented Jun 30, 2023

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:

  1. start a screenreader
  2. https://openfl.readthedocs.io/en/latest/index.html
  3. 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
image

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.

@fstrr
Copy link
Contributor

fstrr commented Jul 5, 2023

This is an issue with the Read The Docs platform.

@psfoley psfoley added good first issue Good for newcomers accessibility Improving accessibility of framework labels Jul 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility Improving accessibility of framework good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants