diff --git a/.github/workflows/_checks.yml b/.github/workflows/_checks.yml index 7cf9b88..b7d307d 100644 --- a/.github/workflows/_checks.yml +++ b/.github/workflows/_checks.yml @@ -24,6 +24,20 @@ jobs: - uses: extractions/setup-just@v4 - uses: astral-sh/setup-uv@v8.2.0 - run: just docs-build + links: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + # --offline blocks network requests and excludes every external URL, so this + # gate is deterministic: it fails only on a relative link or file path that a + # diff actually broke. + - name: Check local links + uses: lycheeverse/lychee-action@v2 + with: + args: >- + --offline + --no-progress + '**/*.md' pytest: runs-on: ubuntu-latest diff --git a/mkdocs.yml b/mkdocs.yml index 766fbb5..f3ea0c4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,13 +4,10 @@ repo_url: https://github.com/modern-python/faststream-outbox docs_dir: docs edit_uri: edit/main/docs/ -# Agent-facing docs are read from the repo, never published. Keeps `mkdocs --strict` from -# failing them as orphaned pages. +# Agent-facing docs and the ADRs are read from the repo, never published. Keeps +# `mkdocs --strict` from failing them as orphaned pages. exclude_docs: | /agents/ - -# ADRs are built (so their outgoing links are validated) but stay out of the site menu. -not_in_nav: | /adr/ nav: