docs: fix MDX/Mermaid build errors in v2 docs#951
Conversation
The Starlight docs build (txpipe/docs) failed compiling the v2 docset merged in #950: - advanced/stateful_cursor.mdx: a `</TabItem>` indented two spaces directly after a Markdown list was absorbed as a loose list-item paragraph, so MDX never saw the closing tag ("Expected the closing tag </TabItem>"). Moving the Tabs/TabItem JSX tags to column 0 with blank lines around the content puts the tags outside the list. - how_it_works.mdx: harden the Mermaid block to canonical syntax (spaced dotted-link labels, non-reserved node id) so rehype-mermaid's img-svg renderer accepts it. Verified with a full local `astro build` of txpipe/docs against this content: 195 pages built, the diagram rasterizes to SVG, all three new pages render. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughTwo documentation files receive whitespace-only edits. ChangesDocumentation Formatting
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Problem
The Starlight docs build (
txpipe/docs) fails compiling the v2 docset merged in #950:Cause & fix
advanced/stateful_cursor.mdx— a</TabItem>indented two spaces sat directly after a Markdown list. A-list's content-indent is two spaces, so the closing tag was absorbed as a loose list-item paragraph and MDX never saw it. Moving allTabs/TabItemtags to column 0 with blank lines around the content puts them outside the list. (The otherTabspages —binary_release,kubernetes— only have fenced code blocks before their closing tags, which parse fine, so they're untouched.)how_it_works.mdx— hardened the new Mermaid block to canonical syntax (spaced-. label .->dotted links, non-reserved node id) sorehype-mermaid'simg-svgrenderer accepts it.Verification
Ran a full local
astro buildoftxpipe/docsagainst this content (deps + Chromium installed for the Mermaid render):data:image/svg+xml,…aria-roledescription='flowchart'SVG (browser render succeeded).how_it_works,quickstart,troubleshooting) render.🤖 Generated with Claude Code
Summary by CodeRabbit