alphagov / govuk-design-system

One place for service teams to find styles, components and patterns for designing government services.
https://www.gov.uk/design-system
MIT License
512 stars 232 forks source link

Make link text for components and patterns consistent #4278

Closed owenatgov closed 1 week ago

owenatgov commented 2 weeks ago

What

Update the text of internal links to components and patterns with the following criteria:

Why

This follows https://github.com/alphagov/govuk-design-system/issues/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:

netlify[bot] commented 2 weeks ago

You can preview this change here:

Name Link
Latest commit 590b1abd832f3899c923cfd0697c80f751fad3c7
Latest deploy log https://app.netlify.com/sites/govuk-design-system-preview/deploys/672e40b2f5a99800081bec2f
Deploy Preview https://deploy-preview-4278--govuk-design-system-preview.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.