vickytnz commented 1 month ago

Suggestion

What is the suggestion?

The NHS prototype kit is similar to buy different from the GOV.UK prototype kit. Some basic differences would help manage expectations for people switching.

What steps are required to do this suggestion?

Noting any key differences:

the install being different npm run watch compared to npm run dev
that it may be missing some functionality
that is may be on an older version of node (and maybe needing a node version manager to switch)

frankieroberto commented 1 month ago

@vickytnz nice idea! I took some notes when moving across too on what the differences are. I can dig those out.

vickytnz commented 4 weeks ago

First pass with more comments. A few principles I have used for this:

always start with the NHS.UK version first to keep things simple and consistent
try to keep things generic enough that it's easy to change - for example not naming the different versions of node
try to use NHS.UK prototype kit when needed but otherwise just

Switching from the GOV.UK prototype kit

If you have used the GOV.UK prototype kit before, most of the things you know are the same in the NHS.UK prototype kit, but there are some differences.

Installing and running the kit

When you are installing and running your prototype kit you need to:

check if you have the right version of node - if you need to use both the NHS.UK and GOV.UK prototype kit at the same time you may need to switch node versions for example by installing a node version manager
run your prototype with the action npm run watch and not npm run dev

Making pages

When you are making your pages you need to:

use the NHS design system for https://service-manual.nhs.uk/design-system/styles, https://service-manual.nhs.uk/design-system/components and https://service-manual.nhs.uk/design-system/patterns
use NHS.UK page templates and layouts - these are different from GOV.UK. If you copy templates from the GOV.UK prototype kit they may not work
use NHS.UK macros instead of GOV.UK ones as they different naming conventions, for example use radios and not govukRadios. You can copy these from the [https://service-manual.nhs.uk/design-system](NHS.UK design system)
be aware that the NHS.UK prototype kit may not have functionality that is in the GOV.UK one, for example, plugins

vickytnz commented 3 weeks ago

Updated dos and don't version is here https://github.com/nhsuk/nhsuk.service-manual.prototype-kit.docs/pull/26#issuecomment-2438669073

nhsuk / nhsuk.service-manual.prototype-kit.docs

Add guidance for anyone switching to the NHS prototype kit from the GOV.UK prototype kit #6