Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a 'what's new' or changelog type page #101

Open
frankieroberto opened this issue Nov 12, 2024 · 5 comments · May be fixed by #135
Open

Add a 'what's new' or changelog type page #101

frankieroberto opened this issue Nov 12, 2024 · 5 comments · May be fixed by #135
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@frankieroberto
Copy link
Contributor

Currently the NHS Prototype kit website doesn’t mention what the current version number is, or what any of the recent changes are.

There is a CHANGELOG in the kit itself, but it might be more usable and accessible to surface some of this within the Prototype kit website.

We could use the What’s new page from the Service Manual as an inspiration?

Possibly also the current version number should be listed on the homepage somewhere?

@vickytnz
Copy link
Contributor

vickytnz commented Nov 18, 2024

The GOV.UK prototype kit has this in its header and also as a way to manage versioning should we make a breaking version https://prototype-kit.service.gov.uk/docs/

GOV.UK prototype header with version in the header

Even if we're not that prominent, another way would be to put it in the footer?

@frankieroberto
Copy link
Contributor Author

The way that the GOV.UK team put "version 13" in the title seems a bit extreme to me - I guess that release wasn't just a breaking change but a completely new structure and way of installing it etc, and maybe there was a need to keep the old docs available for a while? They’re still online here: https://prototype-kit.service.gov.uk/v12/docs/

@vickytnz
Copy link
Contributor

vickytnz commented Nov 19, 2024

Also a bit of whimsy but I wonder about having some form of banner or ticker element to the home page or site to give that sense of things changing, for example as per the GOV.UK non-emergency global banner. https://docs.publishing.service.gov.uk/manual/global-banner.html

My hunch has always been that the govuk design system one is a bit buried when really it's about giving a sense of something changing and then linking off to the more detailed page.

One possible example:

page with section for updates

@vickytnz
Copy link
Contributor

This could actually be a nice way to both make the home page feel less static and be as a cue to go look at changes (I haven't added a link just as that would need some extra css to make it work on a hero image image with area that has a version tag and information

@frankieroberto
Copy link
Contributor Author

Both options look good to me. I think I marginally prefer having it below the hero as maybe we might want to put an inverted “Get started” button in the hero?

@frankieroberto frankieroberto linked a pull request Nov 19, 2024 that will close this issue
@frankieroberto frankieroberto linked a pull request Nov 19, 2024 that will close this issue
@vickytnz vickytnz added the documentation Improvements or additions to documentation label Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Development

Successfully merging a pull request may close this issue.

2 participants