From 43d7bc24ffec308164b76208f82622cc48a64f69 Mon Sep 17 00:00:00 2001 From: Paul Robert Lloyd Date: Wed, 17 Jan 2024 18:13:55 +0000 Subject: [PATCH] Add supported versions to documentation --- docs/autocomplete.md | 2 +- docs/data-attributes.md | 2 +- docs/get-started.md | 5 ++++- docs/masthead.md | 2 +- docs/primary-navigation.md | 2 +- docs/related-navigation.md | 2 +- docs/secondary-navigation.md | 2 +- docs/sub-navigation.md | 2 +- docs/supported-versions.md | 13 +++++++++++++ 9 files changed, 24 insertions(+), 8 deletions(-) create mode 100644 docs/supported-versions.md diff --git a/docs/autocomplete.md b/docs/autocomplete.md index 16d52fb..48faadc 100644 --- a/docs/autocomplete.md +++ b/docs/autocomplete.md @@ -1,6 +1,6 @@ --- layout: sub-navigation -order: 2 +order: 3 title: Autocomplete description: Help users find and select from a number of options. --- diff --git a/docs/data-attributes.md b/docs/data-attributes.md index 6931ce0..df47c0e 100644 --- a/docs/data-attributes.md +++ b/docs/data-attributes.md @@ -1,6 +1,6 @@ --- layout: sub-navigation -order: 7 +order: 8 title: Data attributes description: Use data attributes to help guide users during user research. --- diff --git a/docs/get-started.md b/docs/get-started.md index a22b1c1..01535d4 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -6,7 +6,10 @@ title: Get started ## Requirements -Node.js v18 or later. +- Node.js v18 or later. +- GOV.UK Frontend v5 or later. + +See [supported versions](/supported-versions) for more details. ## Installation diff --git a/docs/masthead.md b/docs/masthead.md index ccee09d..3c5b8d9 100644 --- a/docs/masthead.md +++ b/docs/masthead.md @@ -1,6 +1,6 @@ --- layout: sub-navigation -order: 3 +order: 4 title: Masthead description: Introduce users to your product or service. --- diff --git a/docs/primary-navigation.md b/docs/primary-navigation.md index 89c3879..6c81aaf 100644 --- a/docs/primary-navigation.md +++ b/docs/primary-navigation.md @@ -1,6 +1,6 @@ --- layout: sub-navigation -order: 4 +order: 5 title: Primary navigation description: Link to the primary sections of your service. --- diff --git a/docs/related-navigation.md b/docs/related-navigation.md index 6167a70..ec01e80 100644 --- a/docs/related-navigation.md +++ b/docs/related-navigation.md @@ -1,6 +1,6 @@ --- layout: sub-navigation -order: 5 +order: 6 title: Related navigation description: Show related content when prototyping guidance pages. --- diff --git a/docs/secondary-navigation.md b/docs/secondary-navigation.md index 7fec056..4aa8a73 100644 --- a/docs/secondary-navigation.md +++ b/docs/secondary-navigation.md @@ -1,6 +1,6 @@ --- layout: sub-navigation -order: 5 +order: 6 title: Secondary navigation description: Allow users to navigate between pages scoped to a section. --- diff --git a/docs/sub-navigation.md b/docs/sub-navigation.md index 0311964..34a14f6 100644 --- a/docs/sub-navigation.md +++ b/docs/sub-navigation.md @@ -1,6 +1,6 @@ --- layout: sub-navigation -order: 6 +order: 7 title: Sub navigation description: Link to sibling pages in a multi-page section of your service. --- diff --git a/docs/supported-versions.md b/docs/supported-versions.md new file mode 100644 index 0000000..a07d532 --- /dev/null +++ b/docs/supported-versions.md @@ -0,0 +1,13 @@ +--- +layout: sub-navigation +order: 2 +title: Supported versions +--- + +GOV.UK Prototype Components are actively maintained and support the latest stable versions of the [GOV.UK Frontend](https://frontend.design-system.service.gov.uk), [GOV.UK Prototype Kit](https://prototype-kit.service.gov.uk) and [Node JS](https://nodejs.org). + +| GOV.UK Prototype Components | {{ pkg.version }} | 2.2.2 | +| --------------------------- | ----------------- | ------- | +| GOV.UK Frontend | 5.0.0 | 4.7.0 | +| GOV.UK Prototype Kit | 13.16.0 | 13.16.0 | +| Node JS | 18.0.0 | 18.0.0 |