Repository navigation
fix: EXPKITS-1512 validate prepared documentation sources - #291
Merged
nyari-kovacs-arm merged 1 commit intoNov 17, 2026
Merged
Conversation
Task: EXPKITS-1512 The validation workflow builds raw public Markdown, so links to repository architecture pages fail after the documentation generation refactor. Reuse the publisher's preparation script and validate docs/prepared-public, including its rewritten links, diagram assets and source metadata. Verified source preparation, the complete HTML build with arm-docs 0.12.1 and pnpm 10.33.3 on Node 24, and generated asset links. Local dependencies were fetched through Arm's npm mirror because public npm timed out. Signed-off-by: Nyari-Kovacs, David Tamas <david.nyari-kovacs@arm.com>
gergelybado
approved these changes
Nov 17, 2026
msandor93
approved these changes
Nov 17, 2026
nyari-kovacs-arm
deleted the
bugfix/EXPKITS-1512/validate-prepared-docs
branch
November 17, 2026 09:03
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
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.
Goal
Fix documentation validation failures caused by building raw public Markdown with unresolved links to repository architecture pages. Follow-up to #288.
Change
Reuse
scripts/gen-doc.sh --prepare-publish, then validatedocs/prepared-public, matching the publishing workflow's source preparation and build metadata handling.Testing
arm-docs 0.12.1, pnpm10.33.3, and Node 24; all 35 generated HTML pages passed the repository's local asset/link check.git diff --checkpassed.Local npm dependencies used Arm's mirror because public npm timed out. Browser appearance was not checked.