docs(diagrams): migrate mermaid docs to plantuml and png#66
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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.mdwith embedded PNGs and links to the corresponding.pumlsources. - Added PlantUML sequence diagram sources under
docs/diagrams/*.pumlalong with rendered PNG outputs. - Added a PowerShell script to regenerate PNGs and a central
docs/architecture.mdindex 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.
🧪 Test ResultsUnit Tests
Integration Tests
|
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.



Summary
Notes