Skip to content

docs: convert architectural overview diagrams from JPG to mermaid - #174

Draft
jasonmadigan wants to merge 1 commit into
Kuadrant:mainfrom
jasonmadigan:convert-arch-diagrams-to-mermaid
Draft

docs: convert architectural overview diagrams from JPG to mermaid#174
jasonmadigan wants to merge 1 commit into
Kuadrant:mainfrom
jasonmadigan:convert-arch-diagrams-to-mermaid

Conversation

@jasonmadigan

@jasonmadigan jasonmadigan commented May 1, 2026

Copy link
Copy Markdown
Member

Summary

  • Replace the 7 static JPG diagrams in docs/design/architectural-overview-v1.md with mermaid blocks and remove the JPGs, so diagrams live in the markdown source and can be reviewed and updated as text
  • Diagrams are redrawn 1:1 from the original images: node sets, exact labels, arrow directions, dashed vs solid styles, groupings and colour coding all match. The DNS zone record set for the multi-cluster layout is embedded in that diagram, as in the original image

Test evidence

  • All 7 blocks render with @mermaid-js/mermaid-cli, zero errors
  • Each rendered diagram compared element-by-element against its source JPG (node inventory, label text, edge directions, dashed vs solid, group membership): no discrepancies found
  • Prose outside the diagram blocks is unchanged from main

How to review

The original JPGs are visible as removed files in the diff. Compare each mermaid block against its image; paste blocks into https://mermaid.live if the GitHub render is awkward to zoom.

Closes #173

@coderabbitai

coderabbitai Bot commented May 1, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 215c9c42-0abd-45d1-8ed3-587246a8e0ee

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@jasonmadigan
jasonmadigan marked this pull request as draft May 1, 2026 10:22
@jasonmadigan

Copy link
Copy Markdown
Member Author

First pass is very inaccurate - will need more iterations

@jasonmadigan jasonmadigan changed the title docs: convert architectural overview diagrams from JPG to mermaid WIP: docs: convert architectural overview diagrams from JPG to mermaid May 1, 2026
@jasonmadigan
jasonmadigan force-pushed the convert-arch-diagrams-to-mermaid branch from cec9872 to 71785d3 Compare July 7, 2026 15:10
@jasonmadigan jasonmadigan changed the title WIP: docs: convert architectural overview diagrams from JPG to mermaid docs: convert architectural overview diagrams from JPG to mermaid Jul 7, 2026
Signed-off-by: Jason Madigan <jason@jasonmadigan.com>
@jasonmadigan
jasonmadigan force-pushed the convert-arch-diagrams-to-mermaid branch from 71785d3 to 41037ba Compare July 7, 2026 17:02
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.

Convert architectural overview diagrams from JPG images to mermaid

1 participant