Skip to content

Documentation

Documentation #136

Workflow file for this run

name: Documentation
on:
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/setup-node@v6
with:
node-version: 24
cache: npm
cache-dependency-path: docs-site/package-lock.json
- name: Install docs dependencies
working-directory: docs-site
run: npm ci
- name: Typecheck Docusaurus site
working-directory: docs-site
run: npm run typecheck
- name: Build Docusaurus site
working-directory: docs-site
run: npm run build
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs-site/build
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4