README.md

Template Documentation Site

Use this repository to create a documentation site using the Government Digital Service's tech-docs-gem.

This is recommended for MoJ's technical documentation because:

• It uses the GOV.UK Design System and makes it consistent with other technical documentation sites, including:

  • Cloud Platform's user guide

  • Modernisation Platform's user guide

  • MoJ's technical guidance

  • Operations Engineering's user guide

• Technical and non-technical team members can write your documentation using the ‘docs as code’ approach

---

How to use this template

1. Create a repository using this template (shortcut)

2. Follow the setup instructions from ministryofjustice/template-repository

3. Remove the legacy technical documentation site

   • source/legacy-tdt-documentation

For guidance on using the tech-docs-gem, please refer to the legacy documentation.

Developing

Requirements

• Docker

Previewing locally

Running the following command will run your technical documentation site locally using ministryofjustice/tech-docs-github-pages-publisher, allowing you to access it by visiting http://127.0.0.1:4567 in your browser

make preview

Checking links locally

This repository includes a GitHub Actions workflow that uses Lychee for checking links.

To perform this locally, you will either need to use the dev container or install Lychee, and the run:

make link-check

Publishing

This template includes a GitHub Actions workflow (.github/workflows/publish.yml) for publishing to GitHub Pages when merging to main.