docs.yml

name: Build & Deploy Docs to GitHub Pages

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: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v7
        with:
          # Needed for lastUpdated timestamps in VitePress
          fetch-depth: 0

      - name: Setup Node
        uses: actions/setup-node@v7
        with:
          node-version: "22"
          cache: "npm"

      # ── 1. Install root dependencies (needed for TypeDoc) ──────────────────
      - name: Install root dependencies
        run: npm ci

      # ── 2. Build TypeDoc API reference → docs/api/ ─────────────────────────
      - name: Build API reference (TypeDoc)
        run: npm run docs

      # ── 3. Install VitePress dependencies ──────────────────────────────────
      - name: Install VitePress dependencies
        working-directory: docs-user
        run: npm ci

      # ── 4. Build VitePress user guide → docs/ (overwrites index.html) ──────
      - name: Build user guide (VitePress)
        working-directory: docs-user
        run: npm run docs:build

      # ── 5. Upload combined docs/ folder to GitHub Pages ────────────────────
      - name: Upload artifact for GitHub Pages
        uses: actions/upload-pages-artifact@v5
        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@v5