From 3e202fdda9a30a582737f5d0f05f3368c9055e99 Mon Sep 17 00:00:00 2001
From: Joseph Edwards <josephdavidedwards@gmail.com>
Date: Tue, 2 Jun 2026 14:20:37 +0100
Subject: [PATCH 1/3] Add job to deploy doc

---
 .github/workflows/docs.yml | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 .github/workflows/docs.yml

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..6d9c782
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,28 @@
+name: Documentation
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/configure-pages@v6
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+      - run: pipx run --with mkdocs-material mkdocs build --clean
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+      - uses: actions/deploy-pages@v4
+        id: deployment

From 8f0a3e4a10c2a9e42b53b2f04437f06644883c08 Mon Sep 17 00:00:00 2001
From: Joseph Edwards <josephdavidedwards@gmail.com>
Date: Tue, 2 Jun 2026 14:21:05 +0100
Subject: [PATCH 2/3] Add job to check doc builds without warnings

---
 .github/workflows/tests.yml | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 .github/workflows/tests.yml

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
new file mode 100644
index 0000000..1efbedd
--- /dev/null
+++ b/.github/workflows/tests.yml
@@ -0,0 +1,17 @@
+name: Check documentation builds with no warnings
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  doc-warnings:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Check for warnings
+        # The strict flag treats warnings as errors
+        run: pipx run --with mkdocs-material mkdocs build --clean --strict
+
+# TODO: test the code snippets

From 69f4a77d8183d2f713ac39fb27fbaa735da31394 Mon Sep 17 00:00:00 2001
From: Joseph Edwards <josephdavidedwards@gmail.com>
Date: Tue, 2 Jun 2026 14:24:24 +0100
Subject: [PATCH 3/3] Better names

---
 .github/workflows/tests.yml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 1efbedd..1c9531a 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -1,4 +1,4 @@
-name: Check documentation builds with no warnings
+name: Tests
 on:
   pull_request:
   push:
@@ -7,10 +7,11 @@ on:
 
 jobs:
   doc-warnings:
+    name: Check doc builds without warnings
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-      - name: Check for warnings
+      - name: Build in strict mode
         # The strict flag treats warnings as errors
         run: pipx run --with mkdocs-material mkdocs build --clean --strict