-
Notifications
You must be signed in to change notification settings - Fork 232
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
Make link text for components and patterns consistent #4278
Conversation
✅ You can preview this change here:
To edit notification comments on pull requests, go to your Netlify site configuration. |
c0d6c36
to
0066be7
Compare
0066be7
to
c563888
Compare
2787d6a
to
48fdc59
Compare
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.
Okay, all through it, it's looking good!
I had a look at a few pages in preview, and the appearance of these as links seems to make up for some of the inconsistencies we're introducing between link text and body text. (Like the capitalisations [which we'll fix eventually] and extra words).
Co-Authored-By: Calvin Lau <[email protected]>
5733637
to
590b1ab
Compare
What
Update the text of internal links to components and patterns with the following criteria:
Why
This follows #4267 where we've been auditing our link text so that it can be clearly understood out of context by screen reader users who are navigating by links. From the audit, these links have the most clearly defined criteria to update so we're updating these now.
Notes
Component links are a lot easier to adjust compared to pattern links. Components and the way we refer to components are quite specific in that they're an individual 'classes' so it's quite easy to change eg: 'the footer' to 'the Footer component'. Patterns are more nebulous. Sometimes they're specific things eg: the Validation pattern but they're also 'pages', things to ask for, techniques or tasks.
That means the way we link to patterns are harder to update if we're trying to be strict about criteria for internal links. Eg: it's difficult to update link text like 'ask for national insurance numbers' in the context 'read more about how to ask for national insurance numbers'. Following discussions with @calvin-lau-sig7 and the website accessibility squad, we've establshed some slightly looser criteria for patterns. Notably: