docs: add Mermaid onboarding diagrams#1912
Conversation
|
Merging to
After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here |
|
Reviewed. Mermaid diagrams render against GitHub's native Markdown (the mdBook docs site at Two minor polish suggestions, neither blocking: 1. Mermaid labels with parens
Daemons["Daemon(s)<br/>per machine"]
Quoted form is future-proof against Mermaid version drift and older renderers. Optional. 2. Quickstart sequence ends one step shortThe code block above the new sequence diagram in The diagram covers up to User->>CLI: dora down
CLI->>Daemon: shutdown
CLI->>Coordinator: shutdown
Optional but symmetric with the surrounding text. Thanks for picking this up. The ASCII flow → Mermaid swap is a clear onboarding upgrade. |
Summary
docs/quickstart.mdfor thedora up→dora start→ node messaging →dora stoppath.docs/architecture.mdwith a Mermaid layered diagram.Partially addresses the visual-diagrams portion of #1878. The debugging error table is already being handled separately in #1884.
Validation
typos README.md docs/quickstart.md docs/architecture.mdcargo fmt --all -- --checkRisk
Docs-only change. No runtime behavior changes.