镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

Support mermaid diagrams in RedisVL docs sync - #3583

Merged
paoloredis merged 1 commit into
mainfrom
DOC-6808
Jul 2, 2026
Merged

paoloredis merged 1 commit into
mainfrom
DOC-6808

Conversation

@paoloredis

@paoloredis paoloredis commented Jul 2, 2026 •

Copy link
Copy Markdown
Collaborator

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.

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-mermaid so Sphinx can import upstream conf.py, and preserve_mermaid_fences() in redisvl_docs_sync.py removes "mermaid" from myst_fence_as_directive before build so fences stay as plain ```mermaid blocks instead of being dropped by sphinx_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.

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>
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions

github-actions Bot commented Jul 2, 2026 •

Copy link
Copy Markdown
Contributor

DOC-6808

@jit-ci

jit-ci Bot commented Jul 2, 2026

Copy link
Copy Markdown

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

@paoloredis
paoloredis merged commit ef587ce into main Jul 2, 2026
76 of 77 checks passed
@paoloredis
paoloredis deleted the DOC-6808 branch July 2, 2026 13:43
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.
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.

2 participants