Skip to content

[#12] Render documentation diagrams as images#159

Merged
igorsatsyuk merged 7 commits into
mainfrom
docs/#12-render-diagrams
Jun 2, 2026
Merged

[#12] Render documentation diagrams as images#159
igorsatsyuk merged 7 commits into
mainfrom
docs/#12-render-diagrams

Conversation

@igorsatsyuk

Copy link
Copy Markdown
Owner

Summary

  • Move PlantUML diagram sources into docs/diagrams
  • Add generated PNG diagrams for Markdown rendering
  • Replace inline PlantUML blocks with image embeds across project documentation
  • Add a PowerShell regeneration script for diagram PNGs

Verification

  • Checked that Markdown no longer contains inline PlantUML blocks
  • Checked that all Markdown PNG links resolve locally
  • Confirmed generated PNG diagrams render in IDEA after refresh

Closes #12

Copilot AI review requested due to automatic review settings June 2, 2026 12:56

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 plantuml blocks across documentation with ![...](...png) image embeds and “Source:” links to .puml.
  • Added docs/diagrams/*.puml diagram 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.

Comment thread docs/diagrams/README.md Outdated
Comment thread docs/diagrams/README.md Outdated
Comment thread docs/diagrams/generate_diagrams.ps1

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 19 out of 29 changed files in this pull request and generated 1 comment.

Comment thread docs/diagrams/generate_diagrams.ps1

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 19 out of 29 changed files in this pull request and generated 2 comments.

Comment thread docs/ROADMAP.md Outdated
Comment thread docs/ROADMAP.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 19 out of 29 changed files in this pull request and generated 1 comment.

Comment thread docs/diagrams/README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 19 out of 29 changed files in this pull request and generated 2 comments.

Comment thread docs/diagrams/generate_diagrams.ps1 Outdated
Comment thread docs/diagrams/cqrs-runtime-sequence.puml Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 19 out of 29 changed files in this pull request and generated 2 comments.

Comment thread docs/diagrams/generate_diagrams.ps1
Comment thread docs/diagrams/README.md

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 19 out of 29 changed files in this pull request and generated no new comments.

@igorsatsyuk igorsatsyuk self-assigned this Jun 2, 2026
@igorsatsyuk igorsatsyuk merged commit acb2f47 into main Jun 2, 2026
9 checks passed
@igorsatsyuk igorsatsyuk deleted the docs/#12-render-diagrams branch June 2, 2026 13:49
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.

[DOCS] Документация архитектуры

2 participants