docs: add the reference topology diagram to the architecture page - #1194
Conversation
Adds a "Reference topology" section to Platform architecture with the Whimsical topology export, so readers see the whole deployment before the page walks through each service. The export has a baked-in white background, so it keeps a light canvas in both themes rather than inverting, which would wreck the node fills. The card border, ring, and caption are theme-aware instead, which frames the white panel as deliberate in dark mode. The diagram is too dense to read at the prose column width, so it links to the full-size PNG and breaks out of the article padding on md and up. ~ 🎹 Evanescence, Evan's Agent
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Bumps the figure's inner padding from p-3 to p-4, and to p-6 at md and up, so the diagram has room to breathe inside the white card. ~ 🎹 Evanescence, Evan's Agent
teallarson
left a comment
There was a problem hiding this comment.
Can we adjust the image so it does not show as wider than the rest of the content on the page (it's wider than any text or tables currently)
Once that's done, lgtm so long as we aren't worried about blinding the vampires in dark mode.
Teal flagged that the figure bled wider than every other element on the page. The negative margins are gone, so the figure now matches the text column and the services table exactly (832px at a 1440px viewport). Dark mode was also a full-width white rectangle. The image is dimmed to 83% and the panel behind it moves to neutral-300, the same value, so the two match seamlessly. Brightness scales every channel equally, so the diagram's internal contrast is untouched. ~ 🎹 Evanescence, Evan's Agent
|
Both fixed in ba6b7de. Width — the figure had negative margins (
Exact match now, same in both themes. The vampires — a real concern, it was a full-width white rectangle on a black page. Inverting would have wrecked a color-coded diagram, so instead the image is dimmed with Preview once it redeploys: https://docs-git-docs-reference-topology-diagram-arcade-ai.vercel.app/en/operate/deploy/architecture ~ 🎹 Evanescence, Evan's Agent |
What
Adds a Reference topology section to Platform architecture with our topology diagram, so readers see the whole deployment before the page walks through each service one at a time.
Source diagram: Arcade Reference Topology Diagram — linked in a comment above the figure in the MDX, so the next person knows where to edit it.
Screenshots
Dark mode
Light mode
Light and dark mode
The Whimsical export has a baked-in white background, so inverting it in dark mode would wreck the red/blue/teal node fills. The figure keeps a permanent white canvas and everything around it is theme-aware:
rounded-xl,p-4 md:p-6,bg-white) frames the white panel as deliberate rather than a raw image floating on a dark pageborder-neutral-300/ring-black/5todark:border-neutral-700/dark:ring-white/10text-neutral-600/dark:text-neutral-400Legibility
The diagram is far too dense to read at the ~930px prose column, so:
cursor-zoom-inand a caption that says to open itmdand up (md:-mx-8 lg:-mx-12) to reclaim ~96pxalttext covers the ingress path, both Kubernetes clusters, egress, and the data tierVerification
pnpm lintvalepnpm testpnpm buildRendering confirmed with the screenshots above, and checked at 390 / 820 / 1600px — the figure introduces no horizontal overflow.
Note
The screenshots are hosted on the throwaway
assets/pr-1194-screenshotsbranch so they stay out of this PR's diff and never reachmain. Delete that branch whenever this merges.~ 🎹 Evanescence, Evan's Agent
Note
Low Risk
Documentation-only MDX and styling changes with no runtime or security impact.
Overview
Adds a Reference topology section at the top of the Platform architecture page so readers see the full deployment (ingress, clusters, egress, data tier) before the per-service breakdown.
The section embeds the reference topology PNG via
next/image, wrapped in a clickable figure that opens the full-size image in a new tab, with theme-aware framing (white canvas, dark-mode dimming) and a Whimsical edit link in an MDX comment for maintainers.Reviewed by Cursor Bugbot for commit ba6b7de. Bugbot is set up for automated code reviews on this repo. Configure here.