docs-build.yml

name: Docs Build and Test
on:
    pull_request:
        branches:
            - main

permissions: {}

# Stale runs for a PR are worthless once a new commit lands.
concurrency:
    group: docs-build-${{ github.ref }}
    cancel-in-progress: true

jobs:
    build:
        runs-on: ubuntu-latest
        permissions:
            contents: read
        steps:
            - name: Checkout
              uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
              with:
                  persist-credentials: false
            - name: Setup Node.js
              uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
              with:
                  node-version: '22'
            # Root deps are required: docusaurus-plugin-typedoc reads ../src/*.ts
            # and needs the root dependency types to resolve.
            - name: Install root dependencies
              run: npm ci
            - name: Install docs dependencies
              run: npm ci
              working-directory: docs
            - name: Build docs
              run: npm run build
              working-directory: docs
            - name: Validate links and anchors
              # Docusaurus baseUrl is /javascript/, so all internal links are emitted
              # as /javascript/... . hyperlink treats the given dir as server root "/",
              # so the build must be staged under a matching javascript/ subdirectory
              # for site-absolute links to resolve.
              run: |
                  rm -rf _linkcheck
                  mkdir -p _linkcheck/javascript
                  cp -R docs/build/. _linkcheck/javascript/
                  npx @untitaker/hyperlink _linkcheck --check-anchors