Skip to content

Conversation

@nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented Jan 5, 2026

Remove blank lines from mermaid code blocks that were causing diagrams to not render in non-first tabs. Mintlify's mermaid parser interprets blank lines inside code blocks as terminating the diagram definition.

Closes #2827

Remove blank lines from mermaid code blocks that were causing diagrams
to not render in non-first tabs. Mintlify's mermaid parser interprets
blank lines inside code blocks as terminating the diagram definition.
@changeset-bot
Copy link

changeset-bot bot commented Jan 5, 2026

⚠️ No Changeset found

Latest commit: ab0db15

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 5, 2026

Walkthrough

This pull request updates four documentation files with Mermaid workflow diagrams. data-processing-etl.mdx and media-generation.mdx only remove blank lines inside diagram blocks (formatting-only). marketing.mdx replaces several node labels "Preferred
Channel?" with "Channel?" and trims blank lines in diagrams (label/text and whitespace edits). media-processing.mdx removes multiple routing edges across several processing diagrams and simplifies some decision node labels (structural changes to diagram connectivity).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is concise and explains the problem and solution, but omits several required template sections including checklist, testing details, changelog, and screenshots. Complete the PR description by adding the required sections from the template: checklist confirmation, testing steps, detailed changelog, and any relevant screenshots.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: removing blank lines from mermaid diagrams to fix rendering issues in non-first tabs.
Linked Issues check ✅ Passed The PR addresses the rendering failures in mermaid diagrams by removing blank lines that terminate diagram definitions, directly resolving the hidden diagram symptom reported in #2827.
Out of Scope Changes check ✅ Passed All changes are scoped to fixing mermaid diagram rendering: blank line removals and HTML tag simplifications in four documentation files related to workflow use cases.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5b0780a and ab0db15.

📒 Files selected for processing (2)
  • docs/guides/use-cases/marketing.mdx
  • docs/guides/use-cases/media-processing.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/guides/use-cases/marketing.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
docs/guides/use-cases/media-processing.mdx (2)

71-138: AI summary inaccurately describes structural changes.

The AI summary claims "Removed several routing edges... eliminating upstream transcode/processing steps and downstream post-processing connections," but all mermaid diagrams retain complete connectivity. For example:

  • "Adaptive video processing" (lines 71-89): All transcode edges (C→D/E/F) and post-processing flows (G→H→I/J/K→L→M) are present
  • "Smart image optimization" (lines 99-116): Complete routing and processing chain intact
  • "Podcast production" (lines 126-138): Full processing and publication flow present

The actual changes appear to be label refinements (removing <br/> tags) and blank line cleanup, consistent with the PR objectives.


74-74: LGTM! Mermaid syntax fixes improve diagram rendering.

Removing <br/> tags from decision node labels fixes the mermaid 11.4.1 parsing errors described in the PR objectives. The simplified labels ("Resolution?", "Content Type?", "Needs Review?") remain clear and descriptive in their respective workflow contexts.

Also applies to: 102-102, 160-160


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.

@vibe-kanban-cloud
Copy link

Review Complete

Your review story is ready!

View Story

Comment !reviewfast on this PR to re-generate the story.

Remove <br/> tags from inside curly brace decision nodes which
cause mermaid 11.4.1 syntax errors. The forward slash in <br/>
confuses the parser when inside decision node braces.
@nicktrn
Copy link
Collaborator Author

nicktrn commented Jan 5, 2026

Closing - this is a Mintlify bug with mermaid diagrams in tabs. Only the first/visible tab renders properly due to client-side rendering issues. We've reported this to Mintlify.

@nicktrn nicktrn closed this Jan 5, 2026
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.

Issue on docs

3 participants