docs.yml

name: Docs

# Build the TypeDoc API reference and publish it to GitHub Pages on every push
# to main. Fully automated — no manual steps once Pages is enabled for the repo
# (Settings → Pages → Source: GitHub Actions).

on:
  push:
    branches: [main]
  workflow_dispatch:

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

# Allow one concurrent deployment; newer pushes supersede in-flight runs.
concurrency:
  group: pages
  cancel-in-progress: true

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

      - name: Set up Bun
        uses: oven-sh/setup-bun@v2
        with:
          bun-version: latest

      - name: Install dependencies
        run: bun install --frozen-lockfile

      - name: Build API docs
        run: bun run docs

      # TypeDoc renders README.md as the docs index but does not copy repo assets
      # it references (logo, demo GIF/MP4). Ship them so the relative paths resolve.
      - name: Copy README media into docs site
        run: |
          mkdir -p site/assets
          cp assets/logo.svg assets/logo-dark.svg assets/logo.png \
             assets/demo.gif assets/demo.mp4 site/assets/

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

  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