Repository navigation
Support mermaid diagrams in RedisVL docs sync - #3583
Merged
Merged
Conversation
The RedisVL docs (since upstream v0.21.0) use ```mermaid diagrams, which were both breaking the sync build and, once building, silently dropped. This wires up end-to-end mermaid support without touching generated markdown (the sync workflow regenerates that). - workflow: install sphinxcontrib-mermaid so conf.py's extensions import succeeds and sphinx-build no longer aborts. - redisvl_docs_sync.py: add preserve_mermaid_fences(), run before sphinx_build. It strips "mermaid" from conf.py's myst_fence_as_directive so ```mermaid fences pass through as plain code blocks instead of being converted to a mermaid node that sphinx_markdown_builder drops. - layouts: render fenced ```mermaid client-side at full column width; use mermaid's default font (a custom font mis-sized sequence-diagram boxes and overflowed labels); restore the default pale-yellow subgraph cluster styling to match the upstream docs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
|
Contributor
🛡️ Jit Security Scan Results✅ No security findings were detected in this PR
Security scan by Jit
|
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Jul 4, 2026
Wires up end-to-end mermaid support in the RedisVL docs sync. Conflict in baseof.html resolved to keep the fork's vendored mermaid loader (no CDN import) while adopting the PR's styling fixes (drop Space Mono font, add cluster colours, full-width SVG).
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Jul 18, 2026
Add /park and /pickup Claude Code skills for parked-PR docs.
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Jul 18, 2026
Make dependent data-type and search examples runnable in the interactive CLI.
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Sep 29, 2026
Wires up end-to-end mermaid support in the RedisVL docs sync. Conflict in baseof.html resolved to keep the fork's vendored mermaid loader (no CDN import) while adopting the PR's styling fixes (drop Space Mono font, add cluster colours, full-width SVG).
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Sep 29, 2026
Add /park and /pickup Claude Code skills for parked-PR docs.
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Sep 29, 2026
Make dependent data-type and search examples runnable in the interactive CLI.
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.
The RedisVL docs (since upstream v0.21.0) use mermaid diagrams, which were both breaking the sync build and, once building, silently dropped. This wires up end-to-end mermaid support without touching generated markdown (the sync workflow regenerates that).
Note
Low Risk
Changes are limited to the RedisVL docs sync pipeline and Hugo mermaid presentation; no auth, data, or core app logic.
Overview
Fixes RedisVL doc sync for upstream mermaid diagrams (v0.21.0+): the workflow now installs
sphinxcontrib-mermaidso Sphinx can import upstreamconf.py, andpreserve_mermaid_fences()inredisvl_docs_sync.pyremoves"mermaid"frommyst_fence_as_directivebefore build so fences stay as plain```mermaidblocks instead of being dropped bysphinx_markdown_builder.On the Hugo side, mermaid code blocks default to full column width, client rendering uses mermaid’s default font (avoids sequence-diagram label overflow), adds SVG width scaling, and restores pale-yellow subgraph cluster styling to match upstream docs.
Reviewed by Cursor Bugbot for commit 710a667. Bugbot is set up for automated code reviews on this repo. Configure here.