Skip to content

docs: add Mermaid onboarding diagrams#1912

Merged
heyong4725 merged 1 commit into
dora-rs:mainfrom
leno23:docs/issue-1878-mermaid-diagrams
May 22, 2026
Merged

docs: add Mermaid onboarding diagrams#1912
heyong4725 merged 1 commit into
dora-rs:mainfrom
leno23:docs/issue-1878-mermaid-diagrams

Conversation

@leno23
Copy link
Copy Markdown
Contributor

@leno23 leno23 commented May 22, 2026

Summary

  • Replaces the README architecture ASCII flow with a Mermaid flowchart.
  • Adds a networked-mode sequence diagram to docs/quickstart.md for the dora updora start → node messaging → dora stop path.
  • Replaces the top architecture stack ASCII block in docs/architecture.md with 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.md
  • cargo fmt --all -- --check

Risk

Docs-only change. No runtime behavior changes.

@trunk-io
Copy link
Copy Markdown
Contributor

trunk-io Bot commented May 22, 2026

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

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

@heyong4725
Copy link
Copy Markdown
Collaborator

Reviewed. Mermaid diagrams render against GitHub's native Markdown (the mdBook docs site at guide/ is untouched, so no rendering-pipeline concerns), and the architecture-stack layer claims all match the actual workspace structure in CLAUDE.md. The sequence flow accurately captures dora updora start → messaging → dora stop at the right level of detail for a quickstart.

Two minor polish suggestions, neither blocking:

1. Mermaid labels with parens

README.md flowchart has Daemons[Daemon(s)<br/>per machine]. Renders fine in modern GitHub Mermaid, but the idiomatic safe form is to quote labels that contain (, ), ", [, or ]:

Daemons["Daemon(s)<br/>per machine"]
Loading

Quoted form is future-proof against Mermaid version drift and older renderers. Optional.

2. Quickstart sequence ends one step short

The code block above the new sequence diagram in docs/quickstart.md ends with:

dora stop --all
dora down

The diagram covers up to dora stop --all (last arrow is Coordinator->>Daemon: stop nodes) but doesn't include dora down, which tears down coordinator + daemon. Adding two more arrows would complete the lifecycle:

User->>CLI: dora down
CLI->>Daemon: shutdown
CLI->>Coordinator: shutdown
Loading

Optional but symmetric with the surrounding text.


Thanks for picking this up. The ASCII flow → Mermaid swap is a clear onboarding upgrade.

@heyong4725 heyong4725 merged commit c500301 into dora-rs:main May 22, 2026
12 checks passed
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.

2 participants