Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摎 Documentation: images in cards should have empty alt attributes [a11y][TheA11y100] #284

Closed
2 tasks done
GrahamTheDevRel opened this issue Oct 26, 2023 · 4 comments 路 Fixed by #303
Closed
2 tasks done
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@GrahamTheDevRel
Copy link

GrahamTheDevRel commented Oct 26, 2023

Issue

In the "show me some code" section, the cards are links. Within them are images with alt attributes, however these alt attributes are not descriptive and, more importantly, add duplication of information making the link text longer than needed.

Card on Docs homepage has alt text highlighted

Why it matters

People using assistive technology will end up with extra, repeated or irrelevant information as part of the link text.

Suggested fix

Remove the text within the alt attribute. do not remove the attribute.

An empty alt attribute hides the image from assistive technology so it does not add unnecessary noise within the link. Removing the alt attribute would result in the images URL being read out which would make the problem worse!

Also, it is suggested that you add role="presentation" to the image. This does not doing anything, but it does make it easier for people in the future to realise that the image alt attribute has deliberately been left empty and is a good practice. @Haimantika could you confirm that Appwrite are OK with this policy please.

Relevant Success Criterion WCAG

Link Purpose (In Context)

Additional Notes

Please wait for confirmation from Appwrite on whether to add role="presentation" to images that are decorative (deliberately empty alt attributes mentioned earlier.)

Found on stream on 2023-10-25

馃憖 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

馃彚 Have you read the Code of Conduct?

@GrahamTheDevRel GrahamTheDevRel added the documentation Improvements or additions to documentation label Oct 26, 2023
@TorstenDittmann TorstenDittmann added the good first issue Good for newcomers label Oct 26, 2023
@Sweetdevil144
Copy link
Contributor

Hey @GrahamTheDevRel . Is the still still open?
If so, I would like to work on it!! 馃檪

@Susmita-Dey
Copy link

Hey, I'd like to take up this issue.

@TGlide
Copy link
Contributor

TGlide commented Oct 30, 2023

@Sweetdevil144 assigned 馃槃

@Sweetdevil144
Copy link
Contributor

@TGlide can you verify the PR ! 馃檪

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants