docs(APP-4267): add Mermaid diagrams section to Markdown Viewer#305
docs(APP-4267): add Mermaid diagrams section to Markdown Viewer#305rachaelrenk wants to merge 2 commits into
Conversation
Adds a '## Mermaid diagrams' section to the Markdown Viewer page covering how to insert Mermaid blocks, the Raw/Rendered toggle, and failure/timeout behavior introduced in APP-4267. Also updates the page frontmatter description to mention Mermaid. Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
||
| Each Mermaid block includes a **Raw** and **Rendered** toggle. Use it to switch between the rendered diagram and the original Mermaid source without leaving the viewer. | ||
|
|
||
| ### Render failures and timeouts |
There was a problem hiding this comment.
@rachaelrenk can we remove this section please? i don't think it's necessary to expose this technical detail
| ``` | ||
| ```` | ||
|
|
||
| [TODO: docs reviewer — screenshot of a rendered Mermaid diagram in the markdown viewer] |
There was a problem hiding this comment.
@rachaelrenk do you mind grabbing a screenshot for this? or maybe asking an agent to use computer use to grab one?
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
This PR updates the Markdown Viewer documentation to describe Mermaid diagram rendering, including raw/rendered switching and failure behavior. The content is mostly scoped to the documented feature, but the page currently adds a visible reviewer TODO placeholder that would publish directly to users.
Concerns
- The Mermaid section includes an unresolved screenshot placeholder that must be replaced with final content or removed before merge.
Verdict
Found: 0 critical, 1 important, 0 suggestions
Request changes
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
| ``` | ||
| ```` | ||
|
|
||
| [TODO: docs reviewer — screenshot of a rendered Mermaid diagram in the markdown viewer] |
There was a problem hiding this comment.
2 participants
Note: this is a test PR for a demo of the new feature docs workflow
docs(APP-4267): Mermaid diagrams section — Markdown Viewer
Adds a
## Mermaid diagramssection to the Markdown Viewer page (terminal/more-features/markdown-viewer.mdx) covering the feature introduced in APP-4267 and implemented in warpdotdev/warp#10432.Docs outline
File:
src/content/docs/terminal/more-features/markdown-viewer.mdxSection added:
## Mermaid diagramsmermaidlanguage tag### Switching between raw and rendered— Raw/Rendered toggle### Render failures and timeouts— "Failed to render Mermaid diagram" notice on syntax errors or 10-second timeout; source preservation; independent per-block failure behavior; auto-resolve if render succeeds lateVerified from codebase:
MarkdownMermaidconfirmed incrates/warp_features/src/lib.rs"Failed to render Mermaid diagram"confirmed incrates/editor/src/render/element/mermaid.rsMERMAID_RENDER_TIMEOUT = 10 secondsconfirmed incrates/editor/src/render/element/mermaid.rsItems needing review
[TODO: docs reviewer — screenshot of a rendered Mermaid diagram in the markdown viewer]placeholder at line 105. A screenshot of a Mermaid diagram rendered in the viewer (and optionally the failure notice) would complete this section./cc @zachlloyd
/cc @rachaelrenk @hongyi-chen for docs review