Replace workflow

Update to latest build instructions

.github/workflows/mkdocs.yml → .github/workflows/build_documentation.yml

@@ -1,37 +1,53 @@
-name: Run mkdocs
+name: Build Documentation
+
+# Allows you to run this workflow manually from the Actions tab
+# on:
+#   workflow_dispatch:
+#     branches: ["main"]
+
+# Allows this workflow to run automatically on pushes/commits
 on:
   push:
-    branches:
-      - main
+    branches: ["main"]
 
+
+# Sets permissions of the GITHUB_TOKEN to allow files to be committed to gh-pages branch
 permissions:
   contents: write
+
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
-      - name: Instal pgnquant for optimize plugin
+      - name: Install pgnquant for optimize plugin
         run: sudo apt-get install pngquant
 
       - name: Set up Python runtime
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
 
       - name: Install Python dependencies
         run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
 
       - name: Set up build cache
-        uses: actions/cache@v2
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
         with:
-          key: ${{ github.ref }}
+          key: mkdocs-material-${{ env.cache_id }}
           path: .cache
+          restore-keys: |
+            mkdocs-material-
 
       - name: Install Insiders build
         env:
-          MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }} 
+          MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
         run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
       - run: mkdocs gh-deploy --force