Skip to content

fix: EXPKITS-1512 validate prepared documentation sources - #291

Merged
nyari-kovacs-arm merged 1 commit into
mainfrom
bugfix/EXPKITS-1512/validate-prepared-docs
Nov 17, 2026
Merged

nyari-kovacs-arm merged 1 commit into
mainfrom
bugfix/EXPKITS-1512/validate-prepared-docs

Conversation

@nyari-kovacs-arm

Copy link
Copy Markdown
Contributor

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 validate docs/prepared-public, matching the publishing workflow's source preparation and build metadata handling.

Testing

  • Local container preparation passed; all four previously failing links were rewritten to commit-specific repository URLs.
  • Full production HTML build passed with arm-docs 0.12.1, pnpm 10.33.3, and Node 24; all 35 generated HTML pages passed the repository's local asset/link check.
  • Workflow YAML, preparation ordering, and git diff --check passed.

Local npm dependencies used Arm's mirror because public npm timed out. Browser appearance was not checked.

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>
@nyari-kovacs-arm
nyari-kovacs-arm requested review from a team as code owners November 17, 2026 08:38
@nyari-kovacs-arm
nyari-kovacs-arm merged commit a3747d8 into main Nov 17, 2026
36 checks passed
@nyari-kovacs-arm
nyari-kovacs-arm deleted the bugfix/EXPKITS-1512/validate-prepared-docs branch November 17, 2026 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants