aws-amplify / aws-amplify/docs

Alt text is not descriptive [gen2 pages]

Open
#7,065 0 comments 0 reactions 0 assignees View on GitHub
web accessibility
Dominant language
MDX
Stars
506
Forks
1.1k
Avg merge
3h 14m
Merged PRs (30d)
1

Description

**Describe the content issue**:
Images listed below do not have descriptive/informative alt text. For markdown the alt text is located between the square brackets, `![alt text](...)`.

The list below isn't exhaustive since I found these images based on the word count for the alt text, but it should be a good starting point to make our alt text better for people who use screen readers.

Some resources to help write alt text:
- https://webaim.org/techniques/alttext/
- https://www.a11yproject.com/posts/are-you-making-these-five-mistakes-when-writing-alt-text/

 

https://github.com/aws-amplify/docs/blob/main/src/pages/gen2/deploy-and-host/fullstack-branching/monorepos/index.mdx:
```
52
53: ![monorepo](/images/gen2/fullstack-branching/monorepo.png)
54
```

 

https://github.com/aws-amplify/docs/blob/main/src/pages/gen2/deploy-and-host/sandbox-environments/setup/index.mdx:
```
21
22: ![How cloud sandbox environments work](/images/gen2/how-amplify-works/sandbox.png)
23
```

 

https://github.com/aws-amplify/docs/blob/main/src/pages/gen2/how-amplify-works/concepts/index.mdx:
```
130
131: ![Screenshot showing Figma to Code](/images/gen2/how-amplify-works/ui.jpg)
132
```

 

https://github.com/aws-amplify/docs/blob/main/src/pages/gen2/start/mobile-support/index.mdx:
```
872
873: ![Shows the project details dialog](/images/lib/getting-started/ios/set-up-swift-3.png)
874
```

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the four listed .mdx files and the referenced images: monorepos/index.mdx, sandbox-environments/setup/index.mdx, concepts/index.mdx, and mobile-support/index.mdx. Check each image's content, replace the listed alt text with descriptive text for screen-reader users, and verify that all four affected images have informative alt text.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.