Skip to content

docs(diagrams): migrate mermaid docs to plantuml and png#66

Merged
igorsatsyuk merged 4 commits into
mainfrom
docs/replace-mermaid-diagrams-plantuml
May 31, 2026
Merged

docs(diagrams): migrate mermaid docs to plantuml and png#66
igorsatsyuk merged 4 commits into
mainfrom
docs/replace-mermaid-diagrams-plantuml

Conversation

@igorsatsyuk
Copy link
Copy Markdown
Owner

Summary

  • replace Mermaid diagrams in README with rendered PNG diagrams
  • add PlantUML sources under docs/diagrams/*.puml
  • add docs/architecture.md as the central architecture-diagrams document
  • add docs/diagrams/generate-diagrams.ps1 to regenerate PNG files

Notes

  • this follows the same PlantUML + PNG documentation style used in did-idp-jwt-bridge

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 31, 2026 13:57
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Migrates the project’s architecture/flow documentation from Mermaid-in-README to a PlantUML-source + rendered-PNG approach, and centralizes diagram documentation under docs/architecture.md.

Changes:

  • Replaced Mermaid diagrams in README.md with embedded PNGs and links to the corresponding .puml sources.
  • Added PlantUML sequence diagram sources under docs/diagrams/*.puml along with rendered PNG outputs.
  • Added a PowerShell script to regenerate PNGs and a central docs/architecture.md index for diagrams.

Reviewed changes

Copilot reviewed 8 out of 13 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
README.md Swaps Mermaid blocks for PNG embeds and points to .puml sources; adds link to central architecture doc.
docs/architecture.md New central document that embeds PNGs and references the PlantUML sources.
docs/diagrams/generate-diagrams.ps1 Adds a regeneration script to download PlantUML and render all *.puml to PNG.
docs/diagrams/sequence-auth-login.puml New PlantUML source for login sequence.
docs/diagrams/sequence-auth-refresh.puml New PlantUML source for refresh sequence.
docs/diagrams/sequence-auth-logout.puml New PlantUML source for logout sequence.
docs/diagrams/sequence-async-client-create.puml New PlantUML source for async client creation sequence.
docs/diagrams/sequence-observability-flow.puml New PlantUML source for observability data-flow sequence.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/diagrams/sequence-auth-logout.puml
Comment thread docs/architecture.md Outdated
Comment thread docs/diagrams/generate-diagrams.ps1
Comment thread docs/diagrams/generate-diagrams.ps1
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 31, 2026

🧪 Test Results

Unit Tests

  • Total:
  • Passed: 123
  • Failed: 0
  • Skipped: 1

Integration Tests

  • Total:
  • Passed: 61
  • Failed: 0
  • Skipped: 0

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Copy Markdown

Copilot AI left a comment

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 8 out of 13 changed files in this pull request and generated 2 comments.

Comment thread docs/diagrams/generate-diagrams.ps1 Outdated
Comment thread docs/diagrams/sequence-observability-flow.puml Outdated
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Copy Markdown

Copilot AI left a comment

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 8 out of 13 changed files in this pull request and generated 2 comments.

Comment thread docs/diagrams/sequence-auth-refresh.puml
Comment thread docs/diagrams/generate-diagrams.ps1
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Copy Markdown

Copilot AI left a comment

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 8 out of 14 changed files in this pull request and generated no new comments.

@sonarqubecloud
Copy link
Copy Markdown

@igorsatsyuk igorsatsyuk self-assigned this May 31, 2026
@igorsatsyuk igorsatsyuk merged commit 402de19 into main May 31, 2026
5 checks passed
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.

2 participants