Skip to content

Fix mermaid chart not rendering in hybrid search overview#3553

Merged
qdequele merged 2 commits intomainfrom
fix/hybrid-search-mermaid-chart
Apr 11, 2026
Merged

Fix mermaid chart not rendering in hybrid search overview#3553
qdequele merged 2 commits intomainfrom
fix/hybrid-search-mermaid-chart

Conversation

@qdequele
Copy link
Copy Markdown
Member

@qdequele qdequele commented Apr 10, 2026

Summary

  • Remove <CodeGroup> wrapper around the mermaid flowchart in the hybrid search overview page
  • Mintlify renders mermaid diagrams from standalone fenced code blocks, but wrapping them in <CodeGroup> causes the raw syntax to be displayed instead

Fixes #3543

Test plan

  • Verify the mermaid flowchart renders correctly on the deployed preview at /docs/capabilities/hybrid_search/overview#how-it-works

Summary by CodeRabbit

  • Documentation
    • Updated the hybrid search overview to improve presentation and layout of the workflow diagram for clearer reading.
    • Updated the “choose an embedder” guide to simplify the decision flowchart’s presentation and improve diagram clarity.

Remove CodeGroup wrapper around the mermaid diagram so Mintlify
renders it as a flowchart instead of showing raw mermaid syntax.

Fixes #3543
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 233a7791-8e69-4a5c-9df7-e7f009b23108

📥 Commits

Reviewing files that changed from the base of the PR and between 5e3137f and 746cd0e.

📒 Files selected for processing (1)
  • capabilities/hybrid_search/how_to/choose_an_embedder.mdx
💤 Files with no reviewable changes (1)
  • capabilities/hybrid_search/how_to/choose_an_embedder.mdx

📝 Walkthrough

Walkthrough

Removed <CodeGroup> wrapper tags surrounding Mermaid diagrams in two hybrid search MDX pages so the diagrams can render; the Mermaid markup itself was not changed and no other document content or exported entities were modified.

Changes

Cohort / File(s) Summary
Documentation Markup Fix
capabilities/hybrid_search/overview.mdx, capabilities/hybrid_search/how_to/choose_an_embedder.mdx
Removed surrounding <CodeGroup> wrapper tags from Mermaid diagram sections. The Mermaid diagram markup and logic remain unchanged; only the MDX container tags were deleted, affecting rendered grouping/layout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A ribbon of code hid a Mermaid bright,
I nudged off the wrapper and set it to light.
Diagrams now dance where they once were confined,
Hybrid searches sing—clear, tidy, and aligned.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: removing CodeGroup wrappers to fix mermaid chart rendering in the hybrid search overview.
Linked Issues check ✅ Passed The changes directly address issue #3543 by removing CodeGroup wrappers that prevented mermaid diagrams from rendering correctly in the documentation.
Out of Scope Changes check ✅ Passed All changes are directly related to fixing the mermaid rendering issue; the PR also fixes the same issue on choose_an_embedder.mdx, which is a related scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/hybrid-search-mermaid-chart

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 10, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
meilisearch-documentation 🟢 Ready View Preview Apr 10, 2026, 11:14 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Same issue as the hybrid search overview: CodeGroup wrapper prevents
Mintlify from rendering the mermaid diagram.
@qdequele qdequele merged commit 04e9e1f into main Apr 11, 2026
4 checks passed
@qdequele qdequele deleted the fix/hybrid-search-mermaid-chart branch April 11, 2026 17:26
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.

Bug: Hybrid and semantic search - Mermaid flow chart doesn't show

1 participant