search

github / accessibility-alt-text-bot

An action to remind users to add alt text on Issues, Pull Requests, and Discussions
MIT License
74 stars 13 forks source link

Feature request: Display the inaccessible alt text within the comment body #46

Open inkblotty opened 8 months ago

inkblotty commented 8 months ago

Hi Accessibility-alt-text-bot team :)

Context ❓

When the bot detects inaccessible alt text, or missing alt text, its target is generalized to "in the PR body" or "in the issue body", for example. However, if the issue body, for example, has multiple images, it's not clear which one is missing alt text from the comment itself.

Idea 💡

In the comment body, display which alt text is not accessible and/or which image has inaccessible / missing alt text.

inkblotty commented 8 months ago

Example inaccessible images for testing purposes.

First one:

Image

and a second one:

Image

github-actions[bot] commented 8 months ago

Uh oh! @inkblotty, the image you shared is missing helpful alt text. Check https://github.com/github/accessibility-alt-text-bot/issues/46#issuecomment-1908998643.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

🤖 Beep boop! This comment was added automatically by github/accessibility-alt-text-bot.