uabrc / uabrc/uabrc.github.io

a11y: Review and update image descriptions.

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

Nobody has claimed this yet.

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

Description

For images across the documentation, review the following.

  • Has appropriate alt text.

    Text should be brief and descriptive of the visual appearance of the image. Do not include abstract descriptions, purpose, or fine detail, unless critically important to understanding the image. Try to limit to 7 words or 30 characters.

  • Has a description in body text immediately preceding or following the image.

    The descriptive text should relate the content of the image to the purpose for the image existing at this point in the documentation. It isn't enough to merely describe the image visual content.

  • Transcribes text content in the image, if the text content is relevant to the purpose of the image.

    Screenshots of terminals, code, emails, etc., should have their text transcribed into the body text. For text longer than a few words, or written attributable to another source, use a block quote. For code and terminal contents, use a code block.

  • Has appropriate contrast within the image.

    Key elements of the image should have sufficient contrast with their background. This applies not only to text, but other image features. If key content lacks sufficient contrast and the content is within our control, it should be corrected and the image reacquired. If the content is outside our control, then the content must be described in text. Key content includes, but is not limited to, GUI controls and labels, text intended to be read, and image annotations.

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

Start by locating image references across the documentation; no specific files or tests are named in the issue. Review each image against the stated alt text, nearby description, text transcription, and contrast requirements, and consider the work done when all images meet those accessibility checks.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.