search

alphagov / govuk-frontend-docs

Technical documentation for GOV.UK Frontend
https://frontend.design-system.service.gov.uk/
33 stars 11 forks source link

Add accessibility change list to the v5 changes page #415

Closed dav-idc closed 5 months ago

dav-idc commented 6 months ago

I was hoping to find a place where the fixed v5 accessibility issues were listed in the v5 documentation. Is it alright if a new section is added here?

I pulled the issues from this Github query: https://github.com/alphagov/govuk-frontend/issues?q=milestone%3Av5.0+label%3Aaccessibility

netlify[bot] commented 6 months ago

Deploy Preview for govuk-frontend-docs-preview ready!

Name Link
Latest commit 428a7470eb8b3d3241a52dc92ad0a65c70c5ec2f
Latest deploy log https://app.netlify.com/sites/govuk-frontend-docs-preview/deploys/659e86ae62f5a7000733d05b
Deploy Preview https://deploy-preview-415--govuk-frontend-docs-preview.netlify.app/changes-to-govuk-frontend-v5
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.

36degrees commented 6 months ago

@claireashworth would you be able to take a look at this suggested change?

claireashworth commented 6 months ago

Just one small suggestion from me

36degrees commented 6 months ago

@dav-idc are you happy applying the change that Claire has suggested?

I can update the commit on your behalf if you prefer.

dav-idc commented 6 months ago

Hi @36degrees I'm good with it, yep! I've committed the change.

Over to you!

36degrees commented 6 months ago

There are a few formatting issues with the Markdown that I'm looking at before this can be merged.

@claireashworth this change includes links to all of the pull requests, which we haven't done for anything else on the page. Do you think that's a problem that it's not consistent? I'd be hesitant to add PR links everywhere as it feels like we're heading towards just replicating the release notes…

claireashworth commented 6 months ago

I don't think having the PR links there is a particular problem. Aesthetically-speaking it might not work as well, so as long as there is a way for users to find the additional information in the release notes I can remove them.

dav-idc commented 6 months ago

I had added the links to the PRs, because I hadn't been able to find the accessibility PRs in the release notes. I had to go do a custom search using the 5.0.0 milestone.

dav-idc commented 6 months ago

@36degrees @claireashworth since we're linking to this page for 'more details' on v5 from the upcoming WCAG 2.2 launch blog, can we make an exception and keep the PR links in? The v5 release notes aren't very comprehensive when it comes to describing the accessibility-related changes, which was my reason for suggesting this change.

claireashworth commented 5 months ago

I have no issue either way.

36degrees commented 5 months ago

I've updated the pull request to fix the formatting issues, but have left the links to the pull requests in place.

I did remove the last item from the list ('removed a deprecated class which had the potential to disable link elements') because I think it's very unlikely anyone was actually using it and wouldn't describe it as a 'main accessibility change'. I hope that's OK – let me know if you strongly believe it needed to be left in.

dav-idc commented 5 months ago

Hey @36degrees sounds good, I think I kept it in my suggestion mainly for completion's sake. No strongly held opinion on that one though 👍