Skip to content

docs: add Mermaid diagrams to README and docs - #9

Merged
christiangda merged 1 commit into
mainfrom
docs/mermaid-diagrams
Jul 11, 2026
Merged

docs: add Mermaid diagrams to README and docs#9
christiangda merged 1 commit into
mainfrom
docs/mermaid-diagrams

Conversation

@christiangda

Copy link
Copy Markdown
Contributor

Summary

Adds GitHub-rendered Mermaid diagrams across the README and docs so the architecture, message flow, lifecycle, and SMTP TLS handshake are visual. Replaces the previous ASCII-art diagrams. Docs-only — no code changed.

What's included

README.md

  • Architecture flowchart — producers → builder → buffered queue → worker pool → MailerService → SMTP/custom backend.
  • Message-flow sequence diagramStartEnqueue (with the back-pressure branch) → worker → Send (dial/TLS/AUTH/DATA) → Stop drain.
  • Service-lifecycle state diagram — Ready → Running → Draining/Cancelled → Stopped.

docs/production-guide.md

  • Layered-architecture flowchart (construction / queue+workers / transport).
  • Shutdown state diagram.
  • Enqueue back-pressure decision flowchart (stopped? / queue full? / ctx cancelled?).
  • SMTP TLS/STARTTLS negotiation flowchart (implicit TLS vs STARTTLS vs RequireTLS failure).

docs/examples/basic.md

  • Five-step flow diagram.

docs/examples/custom-backend.md

  • MailerService class diagram (interface, MailContent accessors, implementations, RetryMailer wrapper).
  • Added a concrete RetryMailer wrapper example the diagram references.

Notes

All diagrams use standard Mermaid, which GitHub renders natively in Markdown. State-transition labels avoid <br/> (rendered literally there); node labels use it for wrapping.

🤖 Generated with Claude Code

Replace ASCII diagrams with GitHub-rendered Mermaid and add new ones:

- README: architecture flowchart, message-flow sequence diagram, and a
  service-lifecycle state diagram.
- docs/production-guide.md: layered-architecture flowchart, shutdown state
  diagram, Enqueue back-pressure decision flowchart, and an SMTP TLS/STARTTLS
  negotiation flowchart.
- docs/examples/basic.md: five-step flow diagram.
- docs/examples/custom-backend.md: MailerService class diagram plus a
  RetryMailer wrapper example that the diagram references.

Docs-only change; no code modified.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@christiangda christiangda self-assigned this Jul 11, 2026
@christiangda
christiangda merged commit 5f1dab5 into main Jul 11, 2026
1 check passed
@christiangda
christiangda deleted the docs/mermaid-diagrams branch July 11, 2026 13:17
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.

1 participant