Overhaul for 5.0

.github/workflows/deploy.yml

@@ -42,6 +42,11 @@ jobs:
             - name: Install dependencies
               run: uv sync --all-extras --dev
 
+            - name: Refresh generated snippets
+              run: |
+                  uv run python -m scripts.gen_env_vars
+                  uv run python -m scripts.gen_scheduled_tasks
+
             - name: Set Git user
               run: |
                   git config --global user.name ${{ secrets.GIT_NAME }}
@@ -54,6 +59,7 @@ jobs:
                   git checkout main
 
             - name: Build the documentation
-              run: uv run mike deploy --push --update-aliases ${{ github.event.inputs.version }} latest
               env:
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  VERSION: ${{ github.event.inputs.version }}
+              run: uv run mike deploy --push --update-aliases $VERSION latest

.github/workflows/pr-checks.yml

@@ -0,0 +1,58 @@
+name: PR Checks
+
+on:
+    pull_request:
+        branches: [main]
+
+concurrency:
+    group: pr-checks-${{ github.ref }}
+    cancel-in-progress: true
+
+permissions:
+    contents: read
+    pull-requests: read
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        timeout-minutes: 10
+        steps:
+            - name: Checkout repo
+              uses: actions/checkout@v4.3.0
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@v6.7.0
+              with:
+                  enable-cache: true
+                  cache-dependency-glob: uv.lock
+
+            - name: Set up Python
+              uses: actions/setup-python@v6.0.0
+              with:
+                  python-version-file: .python-version
+
+            - name: Install dependencies
+              run: uv sync --all-extras --dev
+
+            - name: Build docs (strict)
+              run: uv run mkdocs build --strict
+
+            - name: Verify redirect targets exist
+              run: uv run python -m scripts.check_redirects
+
+    link-check:
+        runs-on: ubuntu-latest
+        timeout-minutes: 5
+        steps:
+            - name: Checkout repo
+              uses: actions/checkout@v4.3.0
+              with:
+                  fetch-depth: 0
+
+            - name: Get changed Markdown files
+              id: changed
+              run: |
+                  base="${{ github.event.pull_request.base.sha }}"
+                  head="${{ github.event.pull_request.head.sha }}"
+                  files=$(git diff --name-only "$base" "$head" -- 'docs/**/*.md' | tr '\n' ' ')
+                  echo "files=$files" >> "$GITHUB_OUTPUT"

.gitignore

@@ -4,3 +4,5 @@ site
 .cache
 .DS_Store
 *.kate-swp
+__pycache__
+*.pyc

.trunk/configs/.markdownlint.yaml

@@ -1,2 +1,7 @@
 # Prettier friendly markdownlint config (all formatting rules disabled)
 extends: markdownlint/style/prettier
+
+# MkDocs pages set the page title via frontmatter and repeat it as a body H1.
+# Stop MD025 from counting the frontmatter title as a heading.
+MD025:
+    front_matter_title: ""

.trunk/trunk.yaml

@@ -27,6 +27,12 @@ lint:
         - taplo@0.9.3
         - trufflehog@3.88.12
         - yamllint@1.35.1
+    ignore:
+        # Snippet partials are included into other pages via pymdownx.snippets,
+        # so they intentionally lack a top-level heading and standalone structure.
+        - linters: [markdownlint]
+          paths:
+              - docs/resources/snippets/**
 # actions:
 # enabled:
 # - trunk-announce

CODE_OF_CONDUCT.md

@@ -22,7 +22,7 @@ community include:
 - Giving and gracefully accepting constructive feedback
 - Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals but for the
   overall community
 
 Examples of unacceptable behavior include:

LICENSE

@@ -39,7 +39,7 @@ Work and the meaning and intended legal effect of CC0 on those rights.
 
 1. Copyright and Related Rights. A Work made available under CC0 may be
 protected by copyright and related or neighboring rights ("Copyright and
-Related Rights"). Copyright and Related Rights include, but are not
+Related Rights"). Copyright and Related Rights include but are not
 limited to, the following:
 
   i. the right to reproduce, adapt, distribute, perform, display,
@@ -60,7 +60,7 @@ vii. other similar, equivalent or corresponding rights throughout the
      world based on applicable law or treaty, and any national
      implementations thereof.
 
-2. Waiver. To the greatest extent permitted by, but not in contravention
+2. Waiver. To the greatest extent permitted by but not in contravention
 of, applicable law, Affirmer hereby overtly, fully, permanently,
 irrevocably and unconditionally waives, abandons, and surrenders all of
 Affirmer's Copyright and Related Rights and associated claims and causes