docs-validation.yml

name: Docs Validation

on:
  pull_request:
    paths:
      - "docs/**"
  push:
    branches: ["main"]
    paths:
      - "docs/**"

permissions:
  contents: read

jobs:
  check-broken-links:
    name: Check Broken Links
    runs-on: ubuntu-latest
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@fa2e9d605c4eeb9fcad4c99c224cee0c6c7f3594 # v2.16.0
        with:
          egress-policy: block
          allowed-endpoints: >
            api.github.com:443
            github.com:443
            nodejs.org:443
            ph.mintlify.com:443
            registry.npmjs.org:443
            release-assets.githubusercontent.com:443
            storage.googleapis.com:443

      - name: Checkout repository
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: Set up Node.js
        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
        with:
          node-version: "21"

      - name: Check for broken links
        working-directory: ./docs
        run: |
          echo "Checking for broken links in documentation..."
          npx --yes mintlify@latest broken-links
          echo "✅ No broken links found"