fix

.github/workflows/ci-docs.yml

@@ -4,7 +4,7 @@ on:
   push: 
     branches:
       - main
-      - development
+      - develop
       - release-candidate
   workflow_dispatch:
 
@@ -12,16 +12,15 @@ permissions:
   contents: read
 
 env:
-  MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT:-true }}
+  MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
   MKDOCS_CONFIG: mkdocs/mkdocs.yml 
   MKDOCS_OFFLINE: false
   CSPELL_CONFIG: tools/spellcheck/cspell.yml
-  CSPELL_TARGETS: "docs/**/*.md" README.md
+  CSPELL_TARGETS: docs/**/*.md README.md
 
 jobs:
   build-check:
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -35,7 +34,7 @@ jobs:
         run: |
           set -euo pipefail
           npx --yes cspell \
-            --config ${CSPELL_CONFIG \
+            --config ${CSPELL_CONFIG} \
             ${CSPELL_TARGETS}
 
       - name: Install build dependencies

.github/workflows/deploy-rc-pages.yml

@@ -1,76 +0,0 @@
-name: Deploy RC preview to GitHub Pages
-
-on:
-  push:
-    tags: ["rc*"]
-  workflow_dispatch:
-
-permissions:
-  contents: write
-
-jobs:
-  deploy-rc-pages:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout (tag)
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.11"
-
-      - name: Install dependencies
-        run: |
-          set -euo pipefail
-          pip install -r mkdocs/requirements.txt
-
-      - name: Build site (strict default)
-        run: |
-          set -euo pipefail
-          export MKDOCS_STRICT="${MKDOCS_STRICT:-true}"
-          export TMPDIR="${RUNNER_TEMP:-$TMPDIR}"
-          export OUTPUT_DIR="${OUTPUT_DIR:-${TMPDIR}/dist/}"
-          tools/build.sh --config mkdocs/mkdocs.yml
-
-      - name: Checkout gh-pages branch
-        run: |
-          set -euo pipefail
-          git fetch origin gh-pages:gh-pages || true
-          if git show-ref --verify --quiet refs/heads/gh-pages; then
-            git switch gh-pages
-          else
-            git switch --orphan gh-pages
-            rm -rf ./*
-            git config user.name "github-actions[bot]"
-            git config user.email "github-actions[bot]@users.noreply.github.com"
-            git commit --allow-empty -m "Initialize gh-pages"
-          fi
-
-      - name: Publish RC preview under /rc/<tag>/
-        run: |
-          export TMPDIR="${RUNNER_TEMP:-$TMPDIR}"
-          export OUTPUT_DIR="${OUTPUT_DIR:-${TMPDIR}/dist/}"
-
-          set -euo pipefail
-          rm -rf "rc"* || true
-          mkdir -p "rc/"
-          cp -a "$OUTPUT_DIR/." "rc/"
-
-          git add -A
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-          git commit -m "Deploy RC preview ${GITHUB_REF_NAME}" || echo "No changes to commit"
-          git push origin gh-pages
-      - name: Publish prerelease (GitHub)
-        uses: softprops/action-gh-release@v2
-        with:
-          prerelease: true
-          body: |
-            RC preview: https://<org>.github.io/<repo>/rc/
-
-          Tag: ${{ github.ref_name }}
-          Commit: ${{ github.sha }} 

.github/workflows/release.yml

@@ -3,27 +3,29 @@ name: Build & publish docs (rc + release)
 on:
   push:
     tags:
-      - "rc-*"
+      - "rc*"
       - "v*"
   workflow_dispatch:
 
 permissions:
-  contents: read
+  contents: write
 
 env:
   MKDOCS_CONFIG: mkdocs/mkdocs.yml
-  MKDOCS_OUTPUT_DIR: ${{ runner.temp }}/dist
   MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
 
 jobs:
-  build:
+  publish:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout (tag)
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v5
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
@@ -32,7 +34,7 @@ jobs:
           set -euo pipefail
           pip install -r mkdocs/requirements.txt
 
-      - name: Build docs (strict gate)
+      - name: Build docs (normal + offline, strict gate)
         run: |
           set -euo pipefail
 
@@ -41,27 +43,24 @@ jobs:
             FLAGS+=(--strict)
           fi
 
-          mkdir -p "${MKDOCS_OUTPUT_DIR}"
+          OUT_BASE="${RUNNER_TEMP}/mkdocs_out"
+          SITE="${OUT_BASE}/site"
+          SITE_OFFLINE="${OUT_BASE}/site_offline"
 
-          OFFLINE="${OFFLINE}" mkdocs build \
+          rm -rf "${OUT_BASE}"
-            "${FLAGS[@]}" \
+          mkdir -p "${SITE}" "${SITE_OFFLINE}"
-            -f "${MKDOCS_CONFIG}" \
-            -d "${MKDOCS_OUTPUT_DIR}"
 
-      - name: Zip site
+          mkdocs build "${FLAGS[@]}" -f "${MKDOCS_CONFIG}" -d "${SITE}"
+          OFFLINE=true mkdocs build "${FLAGS[@]}" -f "${MKDOCS_CONFIG}" -d "${SITE_OFFLINE}"
+
+      - name: Zip offline site
         run: |
           set -euo pipefail
-          cd "${MKDOCS_OUTPUT_DIR}"
+          cd "${RUNNER_TEMP}/mkdocs_out"
-          zip -r "${GITHUB_REF_NAME}.zip" .
+          zip -r "${GITHUB_REF_NAME}.zip" site_offline
-  release:
+
-    runs-on: ubuntu-latest
+      - name: Publish prerelease
-    needs: build
+        if: startsWith(github.ref_name, 'rc')
-      steps:
-      # -------------------------
-      # RC-only step
-      # -------------------------
-      - name: Publish prerelease 
-        if: startsWith(github.ref_name, 'rc-')
         uses: softprops/action-gh-release@v2
         with:
           prerelease: true
@@ -70,11 +69,8 @@ jobs:
           body: |
             Release candidate preview (if deployed): /rc/
           files: |
-            ${{ runner.temp }}/${{ github.ref_name }}.zip
+            ${{ runner.temp }}/mkdocs_out/${{ github.ref_name }}.zip
 
-      # -------------------------
-      # Final release-only step
-      # -------------------------
       - name: Publish release
         if: startsWith(github.ref_name, 'v')
         uses: softprops/action-gh-release@v2
@@ -82,12 +78,37 @@ jobs:
           name: ${{ github.ref_name }}
           tag_name: ${{ github.ref_name }}
           files: |
-            ${{ runner.temp }}/${{ github.ref_name }}.zip
+            ${{ runner.temp }}/mkdocs_out/${{ github.ref_name }}.zip
-  deploy:
+
-    runs-on: ubuntu-latest
+      - name: Checkout gh-pages branch
-    needs: build
+        uses: actions/checkout@v4
-    steps:
+        with:
-      - name: Deploy
+          ref: gh-pages
+          fetch-depth: 0
+
+      - name: Deploy release to gh-pages root
+        if: startsWith(github.ref_name, 'v')
         run: |
-          echo "TBD :)"
+          set -euo pipefail
-   
+          rm -rf ./*
+          cp -a ${RUNNER_TEMP}/mkdocs_out/site/. .
+          git add -A
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git commit -m "Deploy release ${GITHUB_REF_NAME}" || echo "No changes to commit"
+          git push origin gh-pages
+
+      - name: Deploy RC preview to /rc/
+        if: startsWith(github.ref_name, 'rc')
+        run: |
+          set -euo pipefail
+          rm -rf rc
+          mkdir -p rc
+          cp -a ${RUNNER_TEMP}/mkdocs_out/site/. rc/
+          printf '{"tag":"%s"}\n' "${GITHUB_REF_NAME}" > rc/rc.json
+
+          git add -A
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git commit -m "Deploy RC preview ${GITHUB_REF_NAME}" || echo "No changes to commit"
+          git push origin gh-pages