Documentation

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

Non-main branches of the documentation are no longer automatically published for review purposes:

Zensical

We use Zensical for the documentation site.

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.

To serve the docs locally:

zensical serve