diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..903227e --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,27 @@ +name: Docs + +on: + push: + branches: [main] + paths: + - 'docs/**' + - 'Sources/**' + - 'Tests/**' + - 'scripts/check-doc-pointers.sh' + - '.github/workflows/docs.yml' + pull_request: + paths: + - 'docs/**' + - 'Sources/**' + - 'Tests/**' + - 'scripts/check-doc-pointers.sh' + - '.github/workflows/docs.yml' + +jobs: + doc-pointers: + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - uses: actions/checkout@v4 + - name: Comments point at headings that exist + run: ./scripts/check-doc-pointers.sh diff --git a/CLAUDE.md b/CLAUDE.md index 3b70e85..931a907 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -28,6 +28,7 @@ swift run -c release pladder-cli