Docs/projects publications

.github/workflows/mkdocs.yml

@@ -1,31 +1,33 @@
-name: Build Documentation using MkDocs 
-# Controls when the action will run. Triggers the workflow on push or pull request 
-# events but only for the master branch 
-# https://medium.com/dev-genius/continuous-deployment-for-mkdocs-with-github-actions-7dceec87f0ea
-on: 
-  push: 
-    branches: [master,main] 
-  pull_request: 
-    branches: [master,main] 
-jobs: 
-  build: 
-    name: Build and Deploy Documentation 
-    runs-on: ubuntu-latest 
-    steps: 
-      - name: Checkout Master 
-        uses: actions/checkout@v2 
+name: Build Documentation using MkDocs
+# Builds the docs (strict, so broken links fail the check) and deploys them to the gh-pages branch,
+# on pushes to main and on pull requests.
+on:
+  push:
+    branches: [main]
+    paths: ['Documentation/**', '.github/workflows/mkdocs.yml']
+  pull_request:
+    branches: [main]
+    paths: ['Documentation/**', '.github/workflows/mkdocs.yml']
+permissions:
+  contents: write
+jobs:
+  build:
+    name: Build and Deploy Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0 # full history for the git-revision-date plugin
       - name: Set up Python
-        uses: actions/setup-python@v5 
-        with: 
-          python-version: '3.x' 
-      - name: Install dependencies 
-        run: | 
-          python -m pip install --upgrade pip 
-          pip install mkdocs-material 
-          pip install mkdocs-git-revision-date-localized-plugin
-          pip install mkdocs-git-committers-plugin-2
-          pip install mkdocs-git-authors-plugin
-          pip install mkdocs-glightbox
-      - name: Deploy 
-        run: | 
-          mkdocs gh-deploy --config-file Documentation/mkdocs.yml --remote-branch gh-pages --force
+        uses: actions/setup-python@v7
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-glightbox
+      - name: Build
+        run: mkdocs build --strict --config-file Documentation/mkdocs.yml
+      - name: Deploy
+        run: mkdocs gh-deploy --config-file Documentation/mkdocs.yml --remote-branch gh-pages --force

.gitignore

@@ -73,9 +73,7 @@ crashlytics-build.properties
 # VSCode folder
 .vscode/
 
-# Ignore auto-generated XR because these are per-end user settings
-/Assets/XR/
-/Assets/XR.meta
+# Assets/XR (XR loader and OpenXR settings) is tracked on purpose so everyone builds with the same settings
 
 Recordings/