Repository navigation
Check the manual's cross-references in CI - #4191
Merged
Merged
Conversation
bbatsov
force-pushed
the
docs-xref-check
branch
from
September 12, 2026 05:56
d566858 to
4a14962
Compare
A broken xref in the tap page shipped in 2.0.0 and went unnoticed for two months, because nothing verifies the Antora sources. This adds a small dependency-free checker that walks the pages and nav, errors on xrefs to missing pages and on missing images, and warns on fragments it can't find (the auto-generated section ids are approximated, and a handful of existing fragments already don't match). A Docs workflow runs it on pushes to master and on pull requests that touch the manual.
Add docs-check, test-ts and test-under-ts so the checks CI runs can be reproduced locally without reading the workflow, list test in .PHONY, and byte-compile before running the unit tests in the default target.
The playbook sets idprefix to nothing and idseparator to a dash, so the checker approximated auto ids with the wrong shape and warned about eight fragments that resolve fine. With the site's settings it warns about the two that are actually broken.
bbatsov
force-pushed
the
docs-xref-check
branch
from
September 15, 2026 10:35
4a14962 to
93dae15
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a small checker for the manual's
xref:andimage:targets, wired into a Docs workflow, plus Makefile targets mirroring the CI steps (docs-check,test-ts,test-under-ts). On master it reports exactly one error, the tap page's xref to a nonexistent inspector page that #4183 fixes, and eight pre-existing fragment mismatches as warnings.