uabrc / uabrc/uabrc.github.io

Mark decorative icons correctly to be ignored by screen readers

Open
#1,193 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dev: enhancement 🛠️✨ fix: accessibility ♿
Dominant language
Python
Stars
24
Forks
15
Avg merge
10d 3h
Merged PRs (30d)
1

Description

Decorative icons, which are present in the new cards and in admonitions, must have correct attributes to be ignored by screen readers. Because they are purely visual with no relevant content, they would only insert noise into a screen reader, making navigation and understanding more complex.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the markup for the new cards and admonitions mentioned in the issue, then inspect how their decorative icons are represented. Verify that purely visual icons are ignored by screen readers and that navigation contains no icon-related noise.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.