You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When contributing code to the WordPress Core codebase, there are automated GitHub actions that check for missing alt tags on images. However, there is no associated action when contributing to documentation.
When writing docs it is imperative to account for accessibility.
In lieu of having to manually check every post before publishing, is it possible to create a GitHub action that will run and make sure all images have alt tags?
URL of the Page with the Issue
During Contributor Day in the February 2024 Mentorship Cohort, I came across #1284 - High Priority, but low-hanging fruit issue for WordPress 6.4
@zzap - to close the ticket above I'm going to double check the links on this page for alt tags and comment that it can be closed.
Section of Page with the issue
Every submitted documentation page. HelpHub, DocHub, etc.
Where all the docs live.
This issue will be persistent if the docs contributor does not include an alt tag when adding images into docs. Contributor onboarding sample use case: Check Block pattern docs for alt tags
Why is this a problem?
Images will be available in most docs, so we will need to always check docs for accessibility (manually for now)
Suggested Fix
Write a GitHub action to check docs page before publishing.
If there are not alt tags in all images, automatically request this be fixed.
Allows for realtime review of documentations for accessibility best practices.
The text was updated successfully, but these errors were encountered:
Hey @flexseth, thanks for your interest in this issue! 🍪🍪🍪 If you have any questions, do not hesitate to ask them in our #docs Slack channel. Enjoy and happy contributing ❤️
Issue Description
When contributing code to the WordPress Core codebase, there are automated GitHub actions that check for missing alt tags on images. However, there is no associated action when contributing to documentation.
When writing docs it is imperative to account for accessibility.
In lieu of having to manually check every post before publishing, is it possible to create a GitHub action that will run and make sure all images have alt tags?
URL of the Page with the Issue
During Contributor Day in the February 2024 Mentorship Cohort, I came across
#1284 - High Priority, but low-hanging fruit issue for WordPress 6.4
@zzap - to close the ticket above I'm going to double check the links on this page for alt tags and comment that it can be closed.
Section of Page with the issue
Every submitted documentation page. HelpHub, DocHub, etc.
Where all the docs live.
This issue will be persistent if the docs contributor does not include an alt tag when adding images into docs. Contributor onboarding sample use case:
Check Block pattern docs for alt tags
Why is this a problem?
Images will be available in most docs, so we will need to always check docs for accessibility (manually for now)
Suggested Fix
If there are not alt tags in all images, automatically request this be fixed.
Allows for realtime review of documentations for accessibility best practices.
The text was updated successfully, but these errors were encountered: