Documentation

The main documentation site is at https://nhs-number.uk-fci.tech. Pushes of code to the main branch will automatically trigger a publication to Netlify.

Non-main branches of the documentation are automatically published to Netlify for review purposes:

• develop -> https://develop.nhs-number.uk-fci.tech
• staging -> https://staging.nhs-number.uk-fci.tech

Material for MkDocs

We use MkDocs along with the Material for MkDocs theme.

You can suggest changes directly through PRs.

When developing the documentation site, we recommend the use of a linter such as markdownlint for VSCode to standardise formatting.