chocolatey / chocolatey/docs

A number of pages have images with poor alt text that can't actually be followed

Open
#1,265 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
223
Forks
248
Avg merge
1d 26m
Merged PRs (30d)
4

Description

### Checklist

- [x] I have verified this is the correct repository for opening this issue.
- [x] I have verified no other issues exist related to my request.

### Is Your Feature Request Related To A Problem? Please describe.

We should update the alt text for the below pages. Currently the alt text is to the effect of `Feature name, if you're on , please see the HTML comment below for full description`, and then there is a comment below that Astro does not actually convert into an HTML comment.

- `package-audit.mdx`
- `package-builder.mdx`
- `package-internalizer.mdx`
- `package-reducer.mdx`
- `package-throttle.mdx`
- `self-service-anywhere.mdx`
- `shim.mdx`
- `automatic-sync.mdx`
- `packages-to-programs.mdx`
- `sync-commands.mdx`

### Describe The Solution. Why is it needed?

We need to ensure that all images have alt text that accurately describe the image.

### User Story

As a user of docs.chocolatey.org,
I want to be shown descriptive text if an image is not displayed correctly,
so that I can understand what the image would have been displaying.

### Additional Context
With NVDA running, the text read out is very cumbersome.

Helpful links:
* https://accessibility.huit.harvard.edu/describe-content-images

### Acceptance Criteria

- [ ] As a user the alt text shown on a missing image accurately describes the image and it's importance.
- [ ] NVDA should be able to accurately read out image alt text.
- [ ] No images on docs.chocolatey.org should be left without proper alt text.

### Related Issues
n/a

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.