Skip to content

Add accessibility docs#3410

Open
Mobey-eth wants to merge 2 commits into
h5bp:mainfrom
Mobey-eth:docs/accessibility-guide
Open

Add accessibility docs#3410
Mobey-eth wants to merge 2 commits into
h5bp:mainfrom
Mobey-eth:docs/accessibility-guide

Conversation

@Mobey-eth
Copy link
Copy Markdown

Summary

  • add a dedicated accessibility guide to the documentation
  • cover semantic structure, skip links, form labels, image alternatives, focus styles, and ARIA usage
  • link the new guide from the docs table of contents and HTML docs

Validation

  • npx prettier --check docs/accessibility.md docs/TOC.md docs/html.md
  • npm test

Closes #3038.

Comment thread docs/accessibility.md
@@ -0,0 +1,108 @@
[HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start on this! Since HTML5 Boilerplate is often a first stop for developers, I think we should aim for this guide to be 'A11y 101.'

Currently, the section on ARIA assumes the reader already knows what it is and when to use it. Define it before mentioning it. I'd also suggest moving the complex ARIA examples to the end (or better yet, removing them entirely) and focusing first on the basics already present in the Boilerplate, like the lang attribute and the .visually-hidden class.

@Mobey-eth
Copy link
Copy Markdown
Author

Mobey-eth commented Apr 22, 2026 via email

@Mobey-eth
Copy link
Copy Markdown
Author

Updated this to keep it more introductory. I moved the guide toward the basics already in the Boilerplate, added a plain definition of ARIA, and removed the more advanced examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[feat] : Enhance Accessibility Documentation for Inclusive Web Development

2 participants