Skip to content

docs: EXPKITS-1554 unify documentation generation - #289

Merged
msandor93 merged 3 commits into
mainfrom
feature/EXPKITS-1554-unify-documentation
Nov 16, 2026
Merged

msandor93 merged 3 commits into
mainfrom
feature/EXPKITS-1554-unify-documentation

Conversation

@msandor93

@msandor93 msandor93 commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Goal

Unify documentation generation for EXPKITS-1554.

Change

Use the pinned Arm renderer and prepare PlantUML assets for the existing publisher. Keep API docs optional and local; align Docker/LXC Node with CI. Publishing remains public-only and retains its existing HTML build.

Testing

Repository checks, 112 WebUI tests, workflow guard test, public-source preparation, and documentation generation with API passed. Other platforms and live publishing remain untested.

Documentation build and server tested locally [good old manual way]

Task: EXPKITS-1554

Reuse the existing CI Node version from requirements/build.json in the
shared development image and LXC setup. Install the official Linux archive
through one checksum-verifying helper instead of distribution Node packages.
Documentation and rich images inherit the supported Node version without
changing their base images or the SDK consumer compatibility requirement.

Signed-off-by: Megyeri Sandor <Sandor.Megyeri@arm.com>
@msandor93
msandor93 requested review from a team as code owners November 16, 2026 04:31
@msandor93
msandor93 force-pushed the feature/EXPKITS-1554-unify-documentation branch from 1cb7138 to c179b9f Compare November 16, 2026 08:57
Comment thread scripts/gen-doc.sh Resolved
Comment thread scripts/gen-doc.sh Resolved
Comment thread Dockerfile Resolved
Task: EXPKITS-1554

Add released arm-docs 0.12.1 and pinned pnpm to the existing documentation image.
Prepare Markdown and embedded PlantUML in a build copy, retain validated local
HTML, and make the linked API reference optional. Keep serving explicit and
remove the obsolete Pandoc and generated PNG paths.

Prepare public sources for the existing publisher without modifying its tools.
Document local Markdown preview without changing development environments or
editor configuration. Release assets and their scope remain unchanged.

Signed-off-by: Megyeri Sandor <Sandor.Megyeri@arm.com>
Task: EXPKITS-1554

Render public diagram assets and stamp the selected commit in an ignored build
copy, then pass it to the existing pinned docs-action validate/publish actions.
Retain their HTML builds, deployment settings, OIDC roles, main-history guard,
and exact release commit selection. No dependency repository changes are required.

Remove the obsolete source-mutating build-info command; reuse its formatting
functions during source preparation.

Signed-off-by: Megyeri Sandor <Sandor.Megyeri@arm.com>
@msandor93
msandor93 force-pushed the feature/EXPKITS-1554-unify-documentation branch from c179b9f to bb33701 Compare November 16, 2026 10:20
@msandor93
msandor93 merged commit 4bb6e6d into main Nov 16, 2026
18 checks passed
@msandor93
msandor93 deleted the feature/EXPKITS-1554-unify-documentation branch November 16, 2026 10:46
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.

2 participants