Skip to main content

Diagrams

Visual journeys that link a screen in the Client surface reference to the backend endpoints it consumes. Each diagram is a Mermaid block embedded in MDX — versionable in git, rendered by Docusaurus, no external tooling.

How to read a diagram

Open a diagram and read top-to-bottom. The opening paragraph names the screen and the endpoint(s); the prose caption above the Mermaid block restates the journey in one sentence; the diagram itself shows the temporal or compositional shape; the closing sections link to the matching client-surface page, the API reference, and any guide whose flow passes through. The pilot is the canonical example.

Authoring a new diagram

See Conventions for the supported diagram types, file naming, palette mapping, cross-link contract, and authoring checklist.

Roster

JourneyTypeDiagramStatus
Ethos onboarding — seed selectionSequenceDiagramCovered
Knowledge file — browse by pathSequenceDeferred (blocked on docs/client/knowledge-file-by-path — Pending in Client surface inventory)
Chat session — bootstrapSequenceDeferred (blocked on docs/client/chat-session — Pending in Client surface inventory)
Note detail — open and editSequenceDeferred (blocked on docs/client/note-detail — Pending in Client surface inventory)
Knowledge — graph renderComponentDeferred (blocked on docs/client/knowledge-graph — Pending in Client surface inventory)
Diagnostics — drill into a recordSequenceDeferred (blocked on docs/client/diagnostic-detail — Pending in Client surface inventory)

Wave-2 diagrams ship as their matching surface pages in Client surface move from Pending to Covered — not on a separate cadence. When a surface page lands, the matching diagram becomes available to author and the Deferred row above becomes either Covered (diagram landed) or Pending (surface up, diagram still to write).