Skip to content

docs: restore original colors, add AI SRE to architecture, reorganize + multi-color diagrams - #310

Merged
krish-kant merged 8 commits into
mainfrom
docs/revert-diagram-restyle
Sep 16, 2026
Merged

krish-kant merged 8 commits into
mainfrom
docs/revert-diagram-restyle

Conversation

@krish-kant

@krish-kant krish-kant commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Restores the original (saturated) diagram palette and improves layout/color usage.

Architecture diagrams (single-location, multi-location, README)

  • Reorganized into a left-to-right layout with labelled zones — Edge, Next.js App, Data Layer, per-region Execution (K3s + gVisor), Connector Layer — so the components spread out instead of clustering in a single block.
  • AI SRE represented: Next.js App shows the AI SRE engine; added Direct Connectors, Private Agents (outbound HTTPS only), and the AI SRE Agent Workspace.
  • Distinct colors for distinct components: app (blue), direct connectors (cyan), private agents (pink), providers (slate), notifications (orange), sandbox (teal), agent workspace (purple); workers and locations share one color as they are the same component.

Sequence diagrams

  • Each participant now has its own color using colored box groups with transparent actor fills, so multiple components show multiple colors (like the architecture diagram) while keeping the original saturated palette.
  • Existing sequences keep their documented detail (alerts, incidents, jobs, playground, monitor) plus the four added ones (Tests, Runs, Status Pages, Private Agent).

Other

  • AI SRE setup flow is now a single horizontal line (was five stacked rows).

Verification

  • All 22 docs diagrams (12 sequence + 10 flow) and the README diagram parse with mermaid 11.
  • npm run lint clean; npm run build succeeds.

Reverts the light-palette restyle and sequence-diagram theming introduced
in #309, restoring the original diagram design across the user-facing docs
(architecture, reliability loop, connectors, status pages, role hierarchy,
AI SRE setup, and all sequence diagrams).

Keeps only the requested addition, in the original design and palette:
the AI SRE engine, the read-only connector layer (Direct Connectors +
Private Agents), and the SRE agent workspace in the single-location,
multi-location, and README architecture diagrams.
- Apply a consistent sequence-diagram theme matching the architecture
  diagrams (indigo actors, amber notes/opt labels, violet activations)
- Add detail to existing sequence diagrams (alerts, incidents, jobs,
  playground, monitor) using the documented behavior
- Add new sequence diagrams:
  - Tests: end-to-end test execution lifecycle
  - Runs: run lifecycle, live updates, cancellation
  - Status Pages: subscriber notifications on incident changes
  - Private Agent: outbound-only registration, heartbeat, lease, result
@krish-kant krish-kant changed the title docs: revert diagram restyle, keep AI SRE in architecture diagrams docs: restore original diagram design, add AI SRE to architecture, theme sequence diagrams Sep 16, 2026
- Architecture (single-location, multi-location, README): switch to a
  left-to-right layout grouped into labelled zones (Edge, App, Data,
  Execution per region, Connector Layer) so elements spread out instead
  of clustering in one block
- Give distinct components distinct colors (app, connectors, private
  agents, providers, notifications, sandbox, agent workspace); workers
  and locations keep a shared color
- Sequence diagrams: color-code each participant with a distinct fill
  (transparent actor backgrounds over colored group boxes) so diagrams
  use multiple colors like the architecture diagram
- Make the AI SRE setup flow a single horizontal line
@krish-kant krish-kant changed the title docs: restore original diagram design, add AI SRE to architecture, theme sequence diagrams docs: restore original colors, add AI SRE to architecture, reorganize + multi-color diagrams Sep 16, 2026
Wide or compact diagrams were being scaled down to fit the content
column, making labels hard to read. Render every diagram at its natural
size (useMaxWidth: false) and let the container scroll horizontally, and
add an Expand/Collapse button that opens the diagram full-screen with an
Escape shortcut. Applies to all docs diagrams (architecture and small).
Remove the expand/collapse fullscreen control. Render every diagram at
its natural size and let the card scroll horizontally so labels stay
readable (previously wide diagrams were scaled down to fit and became
hard to read). Small diagrams remain centered.
- Revert the Mermaid component to fit-to-width rendering (no horizontal
  scrolling, no expand control) so every diagram fits without scrolling
- Restore the earlier simple top-to-bottom architecture layout for
  single-location, multi-location, and README, and add just two blocks:
  AI SRE Engine (App -> SRE) and Private Agents (SRE -.-> Private),
  which adds height instead of width
Remove the heavy full-height colored participant blocks. Use a lighter,
readable theme instead: light actor headings with colored borders,
colored arrows, amber notes/loops, and violet activations, so text stays
visible in both light and dark mode. Applies to all sequence diagrams.
@krish-kant
krish-kant merged commit 3ffa3e6 into main Sep 16, 2026
14 checks passed
@krish-kant
krish-kant deleted the docs/revert-diagram-restyle branch September 16, 2026 11:19
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.

1 participant