Refactor and enhance documentation build workflow

Renamed the workflow file to 'build_documentation.yml' and updated the workflow name to 'Build Documentation'. Improved the workflow by adding submodule update steps, fixing a typo in the install step, and clarifying trigger and permissions. Also removed an unused plugin from the dependencies.

Author: santaimpersonator

.github/workflows/mkdocs.yml renamed to .github/workflows/build_documentation.yml

@@ -1,21 +1,37 @@
-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:
+          submodules: recursive
           fetch-depth: 0
 
-      - name: Instal pgnquant for optimize plugin
+      - name: Update submodules
+        run: |
+          git submodule update --init --recursive
+          git submodule update --recursive --remote
+
+      - name: Install pgnquant for optimize plugin
         run: sudo apt-get install pngquant
 
       - name: Set up Python runtime
@@ -24,7 +40,7 @@ jobs:
           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]'
+        run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
 
       - name: Set up build cache
         run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
@@ -37,6 +53,6 @@ jobs:
 
       - 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