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

bug: address a11y issues for the pfe docs demo pages #1895

Open
kelsS opened this issue Mar 1, 2022 · 2 comments
Open

bug: address a11y issues for the pfe docs demo pages #1895

kelsS opened this issue Mar 1, 2022 · 2 comments
Assignees
Labels
accessibility Improve accessibility docs Documentation updates priority: high Severity level: 1

Comments

@kelsS
Copy link
Contributor

kelsS commented Mar 1, 2022

Description of the issue

The PFE docs site and demos have issues showing up on the audit tools (lighthouse, aXe devtools) as well as issues discovered through manual user testing. The docs are not in compliance with WCAG 2.1 A - AA guidelines.

Impacted component(s)

  • All of the PFE demos

Steps to reproduce

  1. Go to the PFE repo on your local machine
  2. Run npm start in the terminal
  3. Go to any component demo
  4. Run Lighthouse and aXe Devtools on the page
  5. Navigate through the page with your OS screen reader

Expected behavior

  • All the pages should pass the audit tests.
  • All the content should be usable and perceivable by all users
  • The docs should meet the WCAG 2.1 A - AA guidelines

Screenshots

Lighthouse report

pfe-docs-lh-report.pdf

aXe Devtools report

pfe-docs-axe-devtools-report

@kelsS kelsS added accessibility Improve accessibility priority: high Severity level: 1 docs labels Mar 1, 2022
@kelsS kelsS self-assigned this Mar 1, 2022
@bennypowers
Copy link
Member

This is great @kelsS

we recently merged a commit which should configure lighthouse to fail any page that has less than 100% a11y audits, so we should get more exposure for these in PRs

WDYT about taking these one-at-a-time?

@bennypowers
Copy link
Member

Please also consider the pages at /components/*/demo/, which we're using for our visual regression and lighthouse tests

@markcaron markcaron added docs Documentation updates and removed docs labels Nov 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility Improve accessibility docs Documentation updates priority: high Severity level: 1
Projects
None yet
Development

No branches or pull requests

3 participants