Repository navigation
improve: render documentation diagrams with Pele - #288
Merged
Merged
Conversation
Base automatically changed from
roboclaw/docs-expanded-diagrams-20261027
to
main
October 27, 2026 07:21
Co-authored-by: vincentkoc <25068+vincentkoc@users.noreply.github.com>
roboclaw-bot
force-pushed
the
roboclaw/docs-pele-cutover-20261027
branch
from
October 27, 2026 07:23
4dcf477 to
85c29a2
Compare
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 ship Mermaid and redraw on theme changes; the initial Pele candidate can measure labels before its webfonts are ready.
User Impact
Mermaid fences and component blocks render through Pele with the docs font faces and a 16px base size (14px sequence messages). Source exports, accessible descriptions, expansion, keyboard dismissal, navigation and strict diagram isolation remain intact. Layout follows Pele rather than Mermaid. No documentation content or deployment configuration changes are included.
Why This Change Was Made
Use one dependency-free renderer with CSS theme tokens instead of Mermaid initialization, chunk-copying and theme-rerender paths. Pin Pele 1.6.0, copy its complete license, and disable diagram-supplied links and images. Wait for body, bold and monospace label fonts before layout; failed font downloads retain normal browser fallback. Native font smoothing is unchanged. Requested by @vincentkoc.
Work sessions
Evidence
Follows merged #287. The cutover was reconciled onto its landed main commit without changes to renderer code, tests or dependencies. Local proof and screenshots retain their original executing revision; current-head CI is checked separately.
Split: stacked on #287, the independently useful three-file expansion repair. This PR keeps the dependency/lockfile, copied runtime, engine call, tokens and engine-specific checks in one atomic cutover; splitting those further would leave a broken build or temporarily ship two engines. Original #286, its head, body, credit and public evidence remain unchanged until the coordinating parent decides its disposition. No merge is performed here.
Verification limits: hosted checks are pending on these new heads. The prior full test run had seven head-drift mock failures reproduced on the unchanged base because of this host's native gh routing; it is not claimed green and that failing route was not rerun. Direct WebKit HTTP egress was previously refused, so fresh WebKit proof uses actual generated pages fulfilled from disk, not a direct HTTP server. The old #286 CI cancellation occurred during browser package installation before tests ran; no workflow timeout or dependency policy was relaxed.
Full-stack typography refinement on actual docs
Before is the original #286 head; after includes #287 plus this cutover. The expanded mobile view intentionally scrolls horizontally rather than reducing labels to a few pixels.
Before
After