docs.yml

name: Docs

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

# Allow the deploy job to publish to GitHub Pages.
permissions:
  contents: read
  pages: write
  id-token: write

# Avoid overlapping deploys; let an in-progress run finish.
concurrency:
  group: pages
  cancel-in-progress: false

env:
  # Silence the Material-for-MkDocs vendor banner about a future MkDocs 2.0.
  DISABLE_MKDOCS_2_WARNING: "true"

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5

      - name: Install uv
        uses: astral-sh/setup-uv@v8.2.0
        with:
          enable-cache: true

      - name: Set up Python
        run: uv python install 3.12

      - name: Install docs dependencies
        run: uv sync --group docs

      - name: Build site (strict)
        run: uv run mkdocs build --strict

      - name: Upload site as artifact (downloadable preview)
        uses: actions/upload-artifact@v7
        with:
          name: site-preview
          path: site
          retention-days: 14

      - name: Upload Pages artifact
        if: github.ref == 'refs/heads/main'
        uses: actions/upload-pages-artifact@v3
        with:
          path: site

  deploy:
    # Only publish from main; PRs just run the strict build above.
    if: github.ref == 'refs/heads/main'
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4