Skip to content

Commit 1362826

Browse files
lesnik512claude
andcommitted
ci: guard docs drift — mkdocs --strict as a PR check + link/anchor validation
Adds a parallel docs job running mkdocs --strict on PRs (matching the deploy build), a validation block so broken internal links/anchors and orphaned pages fail the build, and upper-bound pins on the docs toolchain. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 068d721 commit 1362826

3 files changed

Lines changed: 16 additions & 2 deletions

File tree

.github/workflows/_checks.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ jobs:
1616
- run: uv python pin 3.11
1717
- run: just install lint-ci
1818

19+
docs:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v6
23+
- uses: extractions/setup-just@v4
24+
- uses: astral-sh/setup-uv@v8.2.0
25+
- run: just docs-build
26+
1927
pytest:
2028
runs-on: ubuntu-latest
2129
strategy:

docs/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
mkdocs
2-
mkdocs-material
1+
mkdocs>=1.6,<2
2+
mkdocs-material>=9,<10

mkdocs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,12 @@ theme:
5050
extra_css:
5151
- css/brand.css
5252

53+
validation:
54+
omitted_files: warn
55+
absolute_links: warn
56+
unrecognized_links: warn
57+
anchors: warn
58+
5359
markdown_extensions:
5460
- toc:
5561
permalink: true

0 commit comments

Comments
 (0)