Skip to content

[docs/diagram] Inventory all existing diagrams across the repository #413

@mesutoezdil

Description

@mesutoezdil

Context

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

Before any diagrams are redrawn, we need a clear picture of what exists today: where diagrams live, what format they are in, and which ones are outdated or inconsistent.

The final diagram set must meet these requirements (keep them in mind during the inventory):

  • Clear separation of control plane and data plane
  • Exported as SVG with editable source files (draw.io or OmniGraffle)
  • Minimal text inside diagrams
  • Reusable visual components across diagrams

Before you start

Please reach out to the maintainers before picking this up:

Scope

Produce a single markdown file docs/diagrams-inventory.md (or open a follow-up comment on this issue) that lists:

  • Every diagram in the repository (images, mermaid blocks, inline ASCII art)
  • File path and the document it appears in
  • Current format (PNG, SVG, Mermaid, ASCII)
  • A short note on whether it is current, outdated, or unclear
  • Whether an editable source file exists
  • Whether it correctly separates control plane from data plane (where applicable)

Acceptance criteria

  • All diagrams across docs/, blog/, i18n/, versioned_docs/, and static/ are covered
  • Each entry has: path, format, status (current / outdated / unknown), source file availability, and control/data plane separation status
  • The output is readable as a plain markdown table or list
  • The inventory is detailed enough to plan the redraw work in the follow-up issue

Notes

  • This is a research and audit task, no drawing required
  • The output of this issue will be used to open and plan the WS4 diagram redraw issue
  • DCO sign-off required on every commit (git commit -s)

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