Repository navigation
improve: render documentation diagrams with Pele - #286
Closed
roboclaw-bot wants to merge 1 commit into
Closed
roboclaw-bot wants to merge 1 commit into
roboclaw-bot wants to merge 1 commit into
Conversation
Co-authored-by: vincentkoc <25068+vincentkoc@users.noreply.github.com>
roboclaw-bot
marked this pull request as ready for review
October 26, 2026 10:06
This was referenced Oct 27, 2026
Contributor
Author
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.
What Problem This Solves
Documentation diagrams currently ship Mermaid and redraw on theme changes even when the source has not changed.
User Impact
Mermaid fences and component blocks render with Pele while preserving source downloads, page copy, expansion, keyboard dismissal, navigation and accessible descriptions. Layout follows Pele rather than Mermaid. No documentation content or live deployment changes are included.
Why This Change Was Made
Use one dependency-free renderer with CSS theme tokens instead of the Mermaid initialization, chunk-copying and theme-rerender paths. Pin Pele 1.6.0, retain the complete MIT/ISC notice in generated assets, and disable diagram-supplied links and images. Requested by @vincentkoc. This documentation-site PR is independent of the application migration stack.
Work sessions
Evidence
Verification limits: broad npm test is 285/292. The seven head-drift mock failures reproduce unchanged on the base (26/33 in that file) because this host invokes an unauthenticated native gh instead of the fixture stub; no credentials were changed. Direct WebKit HTTP smoke was refused by the host loopback egress proxy, so only its generated-page fixture integration is claimed passing. Existing markdown-it audit findings are unchanged.
Before
After
Desktop context
Before
After
Hosted CI follow-up
CodeQL and workflow shell checks passed. Docs Code CI run 40304234063 was cancelled after approximately 30 minutes while Playwright's browser dependency installation was still downloading Ubuntu packages. No renderer build or test step ran in that job; this is neither a green CI result nor a renderer failure. The locally executed focused proof and baseline-qualified broad-test limitations above remain the available verification. No workflow timeout or dependency policy was relaxed.