Update workflow

Replace token variable
Update cache action
Add comments

Author: santaimpersonator

.github/workflows/mkdocs.yml

@@ -1,17 +1,25 @@
 name: Run mkdocs
+
 on:
+  # Allows this workflow to run automatically on commits pushed to main branch
   push:
     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
         run: sudo apt-get install pngquant
@@ -25,13 +33,16 @@ jobs:
         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:
-          GH_TOKEN: ${{ secrets.GH_TOKEN }} 
-        run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
+          MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
+        run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
       - run: mkdocs gh-deploy --force