Add release notes page #252
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
frankieroberto
requested review from
paulrobertlloyd,
vickytnz and
peteryates
|
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
approved these changes
Sep 21, 2024
|
Not sure what the lining errors are, but they’re causing tests to fail on this PR. |
paulrobertlloyd
force-pushed
the
add-release-notes-page
branch
from
5fc3b72 to
565b251
Compare
|
Merging with suggested fixes, can tweak copy in later PRs, if needed. Thanks @frankieroberto. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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