uabrc / uabrc/uabrc.github.io

Clean alt text and improve accessibility of images

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

Nobody has claimed this yet.

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

Description

What is inaccurate?
  • Remove "picture of", "image of" and other redundant language. Screen readers announce this information.
  • Use correct grammar and complete sentences.
  • Shorter than 100 words, preferring a good mix of brevity and clarity.
  • Describe the content and medium of the image.

Images

  • For all text-based images...
    • Must have a description of the important parts of the image placed in the body content and how they relate to the image-local context. This means writing words that tell what the image is intended to communicate, not necessarily what is literally written in the image.
    • If there is no such description, either add one, or replace text-based images with fenced code environments. This allows users to customize their experience for their perceptual needs.

Alt-text is required regardless of descriptive text. Alt-text serves a different purpose than the descriptive text described above. The purpose of alt-text is to communicate the objective or subjective content of the image. This means a description of what a person perceives in the image.

So there are two parts, each with a distinct purpose.

  • Perception (alt-text)
  • Intent (descriptive body text)
Where is the inaccuracy?

All images need review.

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

No files or tests are named; begin by inventorying all images in the documentation and reviewing their surrounding content. Update each image's alt text and add descriptive body text or replace text-based images with fenced code where required. Done means every image has concise, grammatical alt text and relevant intent is documented.

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.