docs.yml

name: Website

on:
  push:
    branches: [main]
    paths: ["website/**", "Scripts/test-docs.sh", "mise.toml", "mise.lock", ".readthedocs.yaml", ".github/workflows/docs.yml"]
  pull_request:
    paths: ["website/**", "Scripts/test-docs.sh", "mise.toml", "mise.lock", ".readthedocs.yaml", ".github/workflows/docs.yml"]
  workflow_dispatch:

permissions:
  contents: read

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

jobs:
  build:
    name: Build the site
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
      - uses: jdx/mise-action@c2a87611a18de5b3828c5652fe268e992400cb5c # v4.3.0
        with:
          version: 2026.9.3
      # Read the Docs publishes the site; this only has to fail when a template or a shortcode breaks.
      - name: Build
        run: just site
      - name: Check the generated pages
        run: |
          cd website
          test -s public/index.html
          test -s public/llms.txt
          test -s public/sitemap.xml
          test -s public/robots.txt
          test -s public/start/index.md
          test -s public/reference/providers/index.md
      - name: Verify documentation links and images
        run: Scripts/test-docs.sh