docs.yml

name: Deploy Docs

on:
  push:
    branches:
      - main # Triggers the deployment pipeline anytime code is pushed to main

jobs:
  build-deploy:
    runs-on: ubuntu-latest
    
    # CRITICAL FIX: Grants the GITHUB_TOKEN write access to push the compiled site to gh-pages
    permissions:
      contents: write

    steps:
      - name: ⬇️ Checkout Repository
        uses: actions/checkout@v7

      - name: 🐍 Set up Python
        uses: actions/setup-python@v7
        with:
          python-version: '3.11'
          cache: 'pip' # Speeds up subsequent pipeline runs

      - name: 📦 Install Documentation Dependencies
        run: |
          python -m pip install --upgrade pip
          pip install mkdocs-material mkdocs

      - name: 🚀 Build and Deploy to GitHub Pages
        run: |
          mkdocs gh-deploy --force