heygen-com--hyperframes/.github/workflows/docs.yml

name: Docs

permissions:
  contents: read

# Suppress hyperframes CLI telemetry from HeyGen's own CI runs.
# External users' CI continues to emit telemetry unless they set this themselves.
env:
  HYPERFRAMES_NO_TELEMETRY: "1"

on:
  pull_request:
    branches: [main]
    paths:
      - "docs/**"
      - "DOCS_GUIDELINES.md"
      - "packages/core/schemas/**"
      - "scripts/sync-schemas.ts"
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "DOCS_GUIDELINES.md"
      - "packages/core/schemas/**"
      - "scripts/sync-schemas.ts"

concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

jobs:
  validate:
    name: Validate docs
    runs-on: ubuntu-latest
    timeout-minutes: 5
    steps:
      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4

      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
        with:
          node-version: 22

      - name: Check schema mirror (core → docs)
        run: npx tsx scripts/sync-schemas.ts --check

      - name: Validate build
        working-directory: docs
        run: npx mint validate

      - name: Check broken links
        working-directory: docs
        run: npx mint broken-links