-
Notifications
You must be signed in to change notification settings - Fork 86
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
docs(storybook): fixes a number of accessibility issues in the documentation #7021
base: master
Are you sure you want to change the base?
Conversation
Outstanding issues: Cannot be directly addressed:
Will require DS input et. al.:
The
|
Looks good @damienrobson-sage. I've changed the label to be pending UX QA as I'd like @harpalsingh to have a look at some bits. Namely we've changed the colour of the highlight and selected states on the left sidebar menu. This is probably fine, but we needed a general look at the general aesthetic of Storybook anyway, so he might as well do it as part of this. Likelihood is we will just create tasks outside of this PR to be addressed, and not require any further changes (unless there's a specific case that makes sense in this PR). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good work on this @damienrobson-sage, I agree with @nineteen88 that getting a UX perspective on these changes would be beneficial.
I'm going to approve, but also thought it was mentioning that it could be a good idea to convert some of these js
files to ts
to match the rest of the codebase. However, I understand it is not really in scope with these changes. So happy to leave it and approve as is 👍
@tomdavies73 I'll leave them as JS for now to avoid scope creep - probably not a good habit to get into on my first ticket 😆 |
fdd2ed1
fdd2ed1
to
fd4f86a
Compare
fd4f86a
to
abaf165
Compare
e02ebb6
to
d5e1058
Compare
Proposed behaviour
The documentation offered by the storybook should be as accessible as possible. This PR aims to implement that by addressing a handful of issues:
header
elementsCurrent behaviour
A wide range of stories feature AXE failings, which results in a poor documentation experience for users who e.g. rely on assistive technologies.
Checklist
d.ts
file added or updated if requiredQA
Additional context
The following issues are embedded within Storybook and can't be directly addressed:
Testing instructions
Install Axe DevTools if not already installed. Open the documentation and then open the browser's inspector and switch to the DevTools tab. Run a full-page scan.