Skip to content

improve: render documentation diagrams with Pele - #286

Closed
roboclaw-bot wants to merge 1 commit into
mainfrom
roboclaw/pele-docs-renderer
Closed

roboclaw-bot wants to merge 1 commit into
mainfrom
roboclaw/pele-docs-renderer

Conversation

@roboclaw-bot

@roboclaw-bot roboclaw-bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

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

  • Bounded 30-page preview build passed.
  • Focused rendering, media-scene and analytics tests: 20/20 passed. Chromium and WebKit executed the actual generated pages through the fixture transport, covering hostile labels, source exports, accessible IDs and expansion. Chromium additionally passed the direct visual flow, themes, focus, overlay/history and navigation.
  • Theme regression fails on the base because theme changes replace diagrams; passes here without replacing SVG nodes.
  • Corpus: 175 source blocks / 163 unique; 162 render. The remaining malformed sequence is rejected by both baseline Mermaid and Pele.
  • Fresh independent P0–P3 review: scoped-clean. Syntax and whitespace checks passed.

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

Documentation diagrams before Pele, mobile light theme

After

Documentation diagrams after Pele, mobile light theme

Desktop context

Before

Documentation diagrams before Pele, desktop light theme

After

Documentation diagrams after Pele, desktop light theme

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.

Co-authored-by: vincentkoc <25068+vincentkoc@users.noreply.github.com>
@roboclaw-bot
roboclaw-bot marked this pull request as ready for review October 26, 2026 10:06
@roboclaw-bot
roboclaw-bot requested a review from a team as a code owner October 26, 2026 10:06
@roboclaw-bot

Copy link
Copy Markdown
Contributor Author

Superseded by merged #287 and #288: the narrow expansion repair and the Pele/font-readiness cutover. Original source and work-session credit remain preserved.

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.

1 participant