Add Python script to check for broken cross-references in AsciiDoc files #1167
Conversation
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
This script analyzes all .adoc files in latest/ug/ to find broken xrefs. It processes files in parallel and detects both xref: and <<>> syntax forms, as well as multiple section ID formats including [[id]], [#id], and auto-generated IDs from section headers. The script reports: - Broken cross-references with file paths and line numbers - Duplicate section IDs across files - Summary statistics Results: Analyzed 394 files, found 3,878 section IDs and 2,241 xrefs, with only 2 broken xrefs (both placeholder examples in contribution docs).
tucktuck9
pushed a commit
that referenced
this pull request
Dec 3, 2025
…les (#1167) This script analyzes all .adoc files in latest/ug/ to find broken xrefs. It processes files in parallel and detects both xref: and <<>> syntax forms, as well as multiple section ID formats including [[id]], [#id], and auto-generated IDs from section headers. The script reports: - Broken cross-references with file paths and line numbers - Duplicate section IDs across files - Summary statistics Results: Analyzed 394 files, found 3,878 section IDs and 2,241 xrefs, with only 2 broken xrefs (both placeholder examples in contribution docs). Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This script analyzes all .adoc files in latest/ug/ to find broken xrefs. It processes files in parallel and detects both xref: and <<>> syntax forms, as well as multiple section ID formats including [[id]], [#id], and auto-generated IDs from section headers.
The script reports:
Results: Analyzed 394 files, found 3,878 section IDs and 2,241 xrefs, with only 2 broken xrefs (both placeholder examples in contribution docs).
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.