Skip to content

Add diagrams to api.md #498

Description

@vidit-admin

Rule 8 in AGENTS.md: a human-facing doc opens with a diagram of the mechanism and the prose explains it. api.md is the one page left without one, and it waits on the shrink row above: drawing the mechanism of 1 800 lines of endpoint reference before the shrink diagrams a page that is about to change shape. Every other human-facing page carries its diagrams, with ingestion.md as the model: one overview plus one diagram per region, reference tables kept as tables. Render every diagram with npx -y @mermaid-js/mermaid-cli -i x.mmd -o x.png -b white -w 1500 and read the PNG before committing. Maintainer decision 2026-08-18.

Imported from planning/backlog.md.

No activity

Activity on this issue will appear here.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions