[#12] Render documentation diagrams as images#159
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the project documentation workflow so architecture/flow diagrams render reliably in Markdown viewers (including GitHub) by switching from inline PlantUML blocks to committed PNG images generated from .puml sources.
Changes:
- Replaced inline
plantumlblocks across documentation withimage embeds and “Source:” links to.puml. - Added
docs/diagrams/*.pumldiagram sources (and corresponding PNGs in the repo) to centralize diagram assets. - Added a PowerShell script to regenerate PNG diagrams locally or via the PlantUML server.
Reviewed changes
Copilot reviewed 19 out of 29 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Replaces inline PlantUML with an embedded PNG for the high-level architecture diagram. |
| docs/ROADMAP.md | Converts embedded PlantUML diagrams to PNG image embeds + source references. |
| docs/CQRS_FLOW.md | Replaces the inline sequence diagram with a PNG embed + .puml source pointer. |
| docs/ARCHITECTURE.md | Replaces multiple inline PlantUML diagrams with PNG embeds + .puml source pointers. |
| deploy/README.md | Switches DB schema diagram from inline PlantUML to a PNG embed sourced from docs/diagrams. |
| CONTRIBUTING.md | Replaces the project structure inline diagram with a PNG embed + source reference. |
| backend/README.md | Replaces the backend integration inline diagram with a PNG embed + source reference. |
| docs/diagrams/README.md | Documents how to regenerate the diagram PNGs. |
| docs/diagrams/generate_diagrams.ps1 | Adds a regeneration script for .puml → .png (local jar or PlantUML server). |
| docs/diagrams/high-level-architecture.puml | Adds the .puml source for the high-level architecture diagram. |
| docs/diagrams/system-overview.puml | Adds the .puml source for the system overview diagram. |
| docs/diagrams/event-topic-flow.puml | Adds the .puml source for the event topic flow diagram. |
| docs/diagrams/database-schema.puml | Adds the .puml source for the DB schema diagram. |
| docs/diagrams/reactive-architecture.puml | Adds the .puml source for the reactive architecture diagram. |
| docs/diagrams/project-structure.puml | Adds the .puml source for the repo/project structure diagram. |
| docs/diagrams/backend-integration-flow.puml | Adds the .puml source for the backend integration flow diagram. |
| docs/diagrams/cqrs-runtime-sequence.puml | Adds the .puml source for the CQRS runtime sequence diagram. |
| docs/diagrams/maven-project-structure.puml | Adds the .puml source for the Maven project structure diagram. |
| docs/diagrams/roadmap-dependency-graph.puml | Adds the .puml source for the roadmap dependency graph diagram. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
igorsatsyuk
added a commit
that referenced
this pull request
Jun 2, 2026
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
Verification
Closes #12