Skip to content

ci: guard docs drift — mkdocs --strict as a PR check + link/anchor validation#149

Merged
lesnik512 merged 1 commit into
mainfrom
chore/docs-ci-drift-guard
Jul 5, 2026
Merged

ci: guard docs drift — mkdocs --strict as a PR check + link/anchor validation#149
lesnik512 merged 1 commit into
mainfrom
chore/docs-ci-drift-guard

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Ports the docs CI drift guard (from faststream-outbox) to this repo.

  • mkdocs.ymlvalidation: block so broken internal links, broken #anchor fragments, and orphaned pages fail the --strict build; also adds the previously-orphaned index.md (the hero landing page) to nav as Overview so the new omitted_files check passes. The homepage already served at /; this only gives it a nav entry.
  • .github/workflows/_checks.yml — parallel docs job running just docs-build on PRs.
  • docs/requirements.txt — pin mkdocs>=1.6,<2, mkdocs-material>=9,<10.

Verified: clean strict build passes.

🤖 Generated with Claude Code

…lidation

Adds the docs PR gate, the validation block, and pinned docs deps. Also adds the
previously-orphaned index.md to the nav (as Overview) so the omitted_files check
passes.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@lesnik512 lesnik512 merged commit 1674c30 into main Jul 5, 2026
8 checks passed
@lesnik512 lesnik512 deleted the chore/docs-ci-drift-guard branch July 5, 2026 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant