Add mermaid architecture diagrams to samples missing an architecture image - #114
Merged
Conversation
…image eventhubs and eventhubs-eventgrid had ASCII-art diagrams and servicebus/java had none. Each now has a mermaid diagram under ## Architecture (a new section for eventhubs-eventgrid, aligning it with the repo convention). The diagrams follow the url-shortener style: subgraphs as containers, numbered flow steps, dotted secondary edges. Visio-made architecture images will follow in a separate PR. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation across multiple samples by replacing ASCII architecture sketches (or adding a missing architecture section) with GitHub-native Mermaid diagrams to standardize and improve readability of sample architectures.
Changes:
- Added a Mermaid architecture diagram to the Service Bus (Java) sample README.
- Replaced the Event Hubs (Python) sample’s ASCII diagram with a Mermaid diagram capturing producers, processing, Capture, and observability components.
- Introduced a new
## Architecturesection with a Mermaid diagram for the Event Hubs + Event Grid (Python) sample.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| samples/servicebus/java/README.md | Adds a Mermaid architecture diagram showing the host-run Spring Boot app send/receive flow to myqueue. |
| samples/eventhubs/python/README.md | Replaces the ASCII architecture sketch with a detailed Mermaid diagram of the end-to-end Event Hubs pipeline. |
| samples/eventhubs-eventgrid/python/README.md | Adds a new Architecture section and Mermaid diagram documenting the Capture → Event Grid → Functions pipeline. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
samples/eventhubs/python: replaces the ASCII-art diagram under## Architecturewith a mermaid diagram (producers over AMQP/Kafka/HTTPS →paymentshub → FraudDetector →fraud-alerts, plus Capture, checkpoints, dashboard, Key Vault, and App Insights/Log Analytics).samples/eventhubs-eventgrid/python: replaces the intro ASCII art with a proper## Architecturesection and a mermaid diagram of the 7-step Capture → Event Grid → Functions pipeline.samples/servicebus/java: adds this sample's first diagram — the host-run Spring Boot app doing the send/receive round trip againstmyqueue.All three diagrams were validated by rendering them with mermaid-cli; GitHub renders them natively. The style matches the existing url-shortener mermaid diagram (subgraphs as containers, numbered primary flow, dotted secondary edges) so each element maps 1:1 onto an Azure icon for the Visio version.
Visio-made architecture images (like the other 11 samples have) will follow in a separate PR.
🤖 Generated with Claude Code