docs.yml

name: Documentation

on:
  push:
    branches:
      - main
  pull_request:
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'overrides/**'
      - '.github/workflows/docs.yml'
      - 'scripts/check_html_links.py'
      - 'scripts/check_doc_refs.py'
      - 'examples/CMakeLists.txt'
      - 'examples/*.yaml'
      - 'docs/images/packet_diagrams/**'
      - 'README.md'

permissions:
  contents: write

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

      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Install dependencies
        run: pip install mkdocs-material pillow

      - name: Generate packet diagram animations
        run: make -C docs/images/packet_diagrams all

      - name: Build site (strict mode)
        run: mkdocs build --strict

      - name: Verify landing page HTML link targets
        run: python scripts/check_html_links.py site

      - name: Verify benchmark and config references in docs
        run: python scripts/check_doc_refs.py

  deploy:
    needs: check
    if: github.event_name == 'push'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Install dependencies
        run: pip install mkdocs-material pillow

      - name: Generate packet diagram animations
        run: make -C docs/images/packet_diagrams all

      - name: Build and deploy
        run: mkdocs gh-deploy --force