Skip to content

[docs/diagram] Redraw all architecture diagrams as SVG with editable source files #421

@mesutoezdil

Description

@mesutoezdil

Context

This issue is part of the HAMi v2.9.0 Documentation Revamp Plan (WS4 - Architecture Diagram Redesign).

The diagram inventory in #413 identifies all existing diagrams and their current state. This issue covers the actual redraw work: replacing outdated or inconsistent diagrams with clean, standardized SVG versions.

Dependency

Blocked by #413. Do not start this issue until the inventory in #413 is complete. The inventory output determines which diagrams need to be redrawn and in what order.

Before you start

Please reach out to the maintainers before picking this up:

Also align with #418 (README architecture narrative) before drawing the main architecture diagram, so the visual matches the written description.

Scope

For each diagram identified as outdated or inconsistent in #413:

  1. Redraw using draw.io or OmniGraffle
  2. Export as SVG and place in static/img/
  3. Archive the editable source file in static/img/src/
  4. Replace the old image reference in the relevant documentation page
  5. Verify the diagram renders correctly in the browser

All redrawn diagrams must follow these requirements:

  • Clear separation of control plane and data plane where applicable
  • Minimal text inside diagrams - labels only, no sentences
  • Consistent visual language across all diagrams (same shapes, colors, and fonts)
  • Reusable components where the same concept appears in multiple diagrams

Acceptance criteria

  • All diagrams flagged in [docs/diagram] Inventory all existing diagrams across the repository #413 have been redrawn
  • Every diagram exists as both an SVG in static/img/ and an editable source file in static/img/src/
  • No diagram contains inconsistent terminology relative to the current docs
  • Control plane and data plane are visually distinct in architecture diagrams
  • Build passes with npm run build
  • DCO sign-off required on every commit (git commit -s)

Notes

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions