docs: add Mermaid diagrams to README and docs - #9
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
MailerService→ SMTP/custom backend.Start→Enqueue(with the back-pressure branch) → worker →Send(dial/TLS/AUTH/DATA) →Stopdrain.docs/production-guide.md
Enqueueback-pressure decision flowchart (stopped? / queue full? / ctx cancelled?).RequireTLSfailure).docs/examples/basic.md
docs/examples/custom-backend.md
MailerServiceclass diagram (interface,MailContentaccessors, implementations,RetryMailerwrapper).RetryMailerwrapper 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