Update GitHub Actions workflow for documentation deployment and enhance contribution guidelines

Author: iMicknl

.github/workflows/docs.yml

@@ -1,16 +1,21 @@
 name: docs
 
 on:
-  push:
-    branches:
-      - main
-      - v2/docs
+  release:
+    types:
+      - created
+  pull_request:
+    paths:
+      - docs/**
+      - mkdocs.yml
+      - pyproject.toml
+      - README.md
 
 permissions:
-  contents: write
+  contents: read
 
 jobs:
-  build-and-deploy:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -25,13 +30,27 @@ jobs:
         uses: astral-sh/setup-uv@v3
 
       - name: Install docs dependencies
-        run: uv pip install -e ".[docs]"
+        run: uv sync --all-extras --dev
 
       - name: Build site
         run: uv run mkdocs build
 
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v4
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: site
+          path: site
+
+  deploy:
+    if: github.event_name == 'release'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/contribute.md

@@ -38,7 +38,7 @@ uv run prek run --all-files
 
 ## Project guidelines
 
-- Use Python 3.10–3.13 features and type annotations.
+- Use Python 3.10+ features and type annotations.
 - Keep absolute imports and avoid relative imports.
 - Preserve existing comments and logging unless your change requires updates.
 - Prefer small, focused changes and add tests when behavior changes.