docs-check.yml

name: Docs Check

on:
  push:
    paths:
      - 'docs/**'
      - '**.md'
      - '**.rst'
    paths-ignore:
      - 'PULL_REQUEST_TEMPLATE.md'
  pull_request:
    paths:
      - 'docs/**'
      - '**.md'
      - '**.rst'
    paths-ignore:
      - 'PULL_REQUEST_TEMPLATE.md'

jobs:
  docs-check:
    name: Validate Documentation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Check Markdown Links (Rust)
        uses: lycheeverse/lychee-action@v2.6.1
        with:
          args: --verbose docs/**/*.md *.md

      - name: Run Spell Check (cspell)
        uses: streetsidesoftware/cspell-action@v2
        with:
          files: docs/**/*.md *.md

      - name: Cleanup temporary files
        run: |
          rm -rf lychee/

      - name: Format Check with Prettier
        run: |
          npm install -g prettier
          npx prettier --check "docs/**/*.md" "**/*.md"