search

x-govuk / govuk-prototype-components

Use common components that are not yet part of the GOV.UK Design System.
https://x-govuk.github.io/govuk-prototype-components/
MIT License
3 stars 2 forks source link

Add release notes page #252

Closed frankieroberto closed 1 month ago

frankieroberto commented 2 months ago

This is a quick idea to add a 'release notes' page where we can document the features and deprecations of major and minor releases in a more accessible way.

This does duplicate the GitHub releases page, but that's possibly harder to follow with all the patch releases and links to specific commits?

The GOV.UK Design System team put all of this detail in their release notes on GitHub (including some great upgrade instructions), but the NHS Design System has quite a nice Updates page which is quite nice.

This is partly motivated by wanting somewhere to link people to if they need help to switch from the Primary navigation component to the new Service navigation component... 🤔

Thoughts? (Content and layout is very rough).

Screenshot

release-notes

peteryates commented 2 months ago

It looks good to me and feels like a more natural home for going into a bit more depth on why the charges were made, detailed upgrade instructions, screenshots, etc.

With the GitHub release notes I know most people will read them when Dependabot posts them in a PR, so it's quick and direct.

paulrobertlloyd commented 1 month ago

Not sure what the lining errors are, but they’re causing tests to fail on this PR.

paulrobertlloyd commented 1 month ago

Merging with suggested fixes, can tweak copy in later PRs, if needed. Thanks @frankieroberto.