Skip to content

Add a docs validator: fragment anchors, broken paths, part-number consistency #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
munzzyy wants to merge 2 commits into
base: public-release
Choose a base branch
from
Open

Add a docs validator: fragment anchors, broken paths, part-number consistency #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
efb8314
Add a docs link/anchor/part-number validator tool
munzzyy Jul 17, 2026
6e26290
Fix image path resolution, split checks, drop part-number check
munzzyy Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/validate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,21 @@ jobs:

- name: Detect broken links
run: archbee broken-links

docs-validator:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v6

# Archbee's own broken-links check above confirms a link's target
# file exists, but not that a #fragment resolves to a real heading.
- name: Check anchor fragments
run: python3 tools/validate_docs.py --check anchor

# Stricter than Archbee's own check for image references: resolves
# them the way Archbee actually does (see tools/validate_docs.py)
# instead of just checking the target file exists.
- name: Check internal link and image paths
run: python3 tools/validate_docs.py --check path
Loading