docs: replace Mermaid diagrams with PlantUML for IDEA rendering#158
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR migrates documentation diagrams from Mermaid (and ASCII/text diagrams) to PlantUML so they render consistently in IntelliJ IDEA’s Markdown preview when the PlantUML extension is enabled.
Changes:
- Replaced Mermaid/ASCII diagrams with PlantUML in top-level, backend, deploy, and architecture docs.
- Updated CQRS runtime flow and roadmap dependency/structure diagrams to PlantUML equivalents.
- Kept existing documentation sections/structure while changing diagram syntax.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Replaces the high-level architecture Mermaid diagram with a PlantUML component/dataflow diagram. |
| CONTRIBUTING.md | Converts the project structure tree into a PlantUML folder diagram. |
| backend/README.md | Converts the backend integration flow diagram to PlantUML. |
| deploy/README.md | Converts the DB schema snippet to a PlantUML entity diagram. |
| docs/ARCHITECTURE.md | Converts system overview, topic/consumer flow, and reactive stack diagrams to PlantUML. |
| docs/CQRS_FLOW.md | Replaces the end-to-end sequence text diagram with a PlantUML sequence diagram. |
| docs/ROADMAP.md | Converts the backend module structure and dependency graph diagrams to PlantUML. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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.
Description
Replaced Markdown Mermaid diagrams with PlantUML so diagrams render reliably in IntelliJ IDEA Markdown preview with PlantUML extension enabled.
What changed
Files