alphagov / govuk-frontend-docs

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

Host v4 in its own folder #384

Closed romaricpascal closed 10 months ago

romaricpascal commented 10 months ago

Cherry picks the commits from the spike exploring how to host docs for v4 in their own folder, next to those of v5.

The commits paint a good pictures of the changes, but as a summary:

Closes #346.

netlify[bot] commented 10 months ago

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

Name Link
Latest commit 2dc181cb31797a0c5e776ca866d0c19660b7c1f3
Latest deploy log https://app.netlify.com/sites/govuk-frontend-docs-preview/deploys/655f87f478a42f00087d9abc
Deploy Preview https://deploy-preview-384--govuk-frontend-docs-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.

36degrees commented 10 months ago

I've spent a bit of time trying to get this passing on CI. I've forced push some changes that amend some of the existing commits. They're mainly fixing rubocop violations – you can see the changes here.

I'm not entirely sure about this change, which changes rescue to rescue StandardError to avoid Rubocop's 'Avoid rescuing without specifying an error class' error. I don't know if there's a more specific error class we could be rescuing because I'm unsure what it is we're guarding against.

I've also pushed some additional commits to fix a couple of broken links.

The only other thing I've noticed is that the highlighting of the current page / section in the side navigation is broken in the v4 docs, I think related to some of the logic in the tech docs JavaScript that checks URLs match, but I haven't quite got my head around it yet. I don't think this is critical to shipping v5 but it'd be good to fix if possible.

romaricpascal commented 10 months ago

Cheers for looking into it 😊 That rescue should actually be an ensure (aim is to make the equivalent of a try {} finally {} to ensure things are reset whatever happens), so that'll avoid the rubocop complaints.

stevenjmesser commented 10 months ago

image

I’m loving the version selector so that users can move between documentation for different versions of GOV.‌UK Frontend. So good!