Skip to content

Commit 1674c30

Browse files
lesnik512claude
andauthored
ci: guard docs drift — mkdocs --strict as a PR check + link/anchor validation (#149)
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>
1 parent 204d164 commit 1674c30

3 files changed

Lines changed: 17 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.10
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: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ repo_url: https://github.com/modern-python/lite-bootstrap
44
docs_dir: docs
55
edit_uri: edit/main/docs/
66
nav:
7+
- Overview: index.md
78
- Introduction:
89
- Quickstart: introduction/quickstart.md
910
- Installation: introduction/installation.md
@@ -51,6 +52,12 @@ theme:
5152
icon: material/brightness-4
5253
name: Switch to system preference
5354

55+
validation:
56+
omitted_files: warn
57+
absolute_links: warn
58+
unrecognized_links: warn
59+
anchors: warn
60+
5461
markdown_extensions:
5562
- toc:
5663
permalink: true

0 commit comments

Comments
 (0)