Repository navigation
docs: EXPKITS-1554 unify documentation generation - #289
Merged
Merged
Conversation
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
force-pushed
the
feature/EXPKITS-1554-unify-documentation
branch
from
November 16, 2026 08:57
1cb7138 to
c179b9f
Compare
Szendvics
reviewed
Nov 16, 2026
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
force-pushed
the
feature/EXPKITS-1554-unify-documentation
branch
from
November 16, 2026 10:20
c179b9f to
bb33701
Compare
Szendvics
approved these changes
Nov 16, 2026
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
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]