docs.yml

name: Documentation

on:
  push:
    branches: [main]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: true

jobs:
  build:
    runs-on: macos-26
    steps:
      - uses: actions/checkout@v4

      - name: Build documentation
        run: |
          swift package --allow-writing-to-directory docs \
            generate-documentation --target VISOR \
            --output-path docs \
            --transform-for-static-hosting \
            --hosting-base-path VISOR

      - name: Fix GitHub Pages SPA routing
        run: cp docs/index.html docs/404.html

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs

  deploy:
    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