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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an accessibility section to the documentation for each component #337

Open
1 task
sandbergja opened this issue Aug 28, 2024 · 0 comments
Open
1 task
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sandbergja
Copy link
Member

Introduction

For each component, we should have an accessibility section that describes:

  • accessibility features of the component
  • considerations that you need to keep in mind when using this component in your application

We are particularly inspired by Mercury, the design system from the Canada Post, which has an Accessibility Tab in the documentation for each of its components.

Acceptance criteria

  • Each component has an accessibility section

Implementation notes

We could create a custom component for displaying Accessibility information in the documentation.

@sandbergja sandbergja added the documentation Improvements or additions to documentation label Aug 28, 2024
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
Projects
None yet
Development

No branches or pull requests

2 participants