-
Notifications
You must be signed in to change notification settings - Fork 236
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
Update links to WCAG criteria to make them clearer #4313
Conversation
✅ You can preview this change here:
To edit notification comments on pull requests, go to your Netlify site configuration. |
These are looking good. IMO ideally the callout links would also include the 'make sure that' from the lead-in paragraph to make it as clear as possible but I think that might tip this over into make the link too wordy and the experience bad for everyone else. Question for you @calvin-lau-sig7: Do you think that instances of components need a 'component' suffix? For example the second callout link for back links is now 'users can interact with Back links' and I wonder if it should be 'users can interact with Back link components'. I'm not 100% about that as feedback because the user has the context of the page they're on so interested in your thoughts here. |
Yeah, I better add the "component/pattern" words in... But seeing as we're taking the wordy approach as standard, it makes sense for us to go use the wordy version everywhere it makes sense to. I'll edit the PR... |
@selfthinker As mentioned in standup, here's a few things I wanted to mention for your awareness. I'm looking to make these widespread edits:
The style format for the success criterion is my best interpretation of following the GOV.UK style guide – alas WCAG's style for success criterion is inconsistent across their website. I'm open to any other comments you have on these changes as well! |
ba09f09
to
44c25b3
Compare
@owenatgov Looking at this again, this might be a good move... let me have a think 🤔 |
I've taken in @owenatgov's suggestion to move the "make sure that" wording into the links, as I've agreed that it'll make the link text much clearer as messages. I've made the edits as a new commit and will verify it all looks good in preview tomorrow. We'll need to review these in PR before push. cc @selfthinker |
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.
Content is looking SHARP. This is all but approved. I'll say my usual commit history thing. Happy to chat through that more.
Co-Authored-By: Calvin Lau <[email protected]>
9f3be66
to
eee1d68
Compare
What
Changes identified unclear links on all WCAG-related links on the Design System.
This was done as a batch job to address about 40 flagged links in the link text audit, but these changes have not been drafted or approved there.
Full review of the changes in this PR is needed before publish.
What we've done
All instances of link text to WCAG 2.2 criteria are clearly identified as WCAG 2.2 criteria, with SC number and name
On the top-of-page WAG 2.2 call-outs, we've removed "users can successfully" at the end of the lead-in line into the anchor links.
As a result, we've edited all the anchor links to be more descriptive within the link text, instead of relying on the lead-in sentence.
Why
This more clearly communicates what the link is and where it goes to. Part of #4267.