Skip to content

docs: add Mermaid architecture diagram to README #81

Description

@zanni098

Problem

The README and docs lack a visual architecture diagram. The ARCHITECTURE.md has a pipeline diagram in text, but there is no visual diagram in the README that shows how the components fit together.

Proposed Solution

Add a Mermaid architecture diagram to README.md showing:

  1. Discovery sources (OpenAPI, HAR, Browser, mitmproxy)
  2. Core pipeline (Spec parsing, Archetype detection, Generation)
  3. Output targets (Python, Go, Rust, TS, MCP, Skills)
  4. Quality layer (Scorecard, Proof, shipcheck)
  5. Web UI and Catalog

Also add the diagram to docs/ARCHITECTURE.md as a renderable Mermaid block.

Acceptance Criteria

  • Mermaid diagram in README.md
  • Same diagram in docs/ARCHITECTURE.md
  • Diagram renders correctly on GitHub
  • Diagram covers all major components

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

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions