Skip to content

[Docs] Create Mermaid.js Architecture Diagrams for README #4

@Vishisht16

Description

@Vishisht16

🎯 Objective

Convert our text-based ASCII architecture diagrams in the README.md into beautiful, renderable Mermaid.js diagrams.

💡 Why this matters

HumaneProxy uses a complex 3-stage cascading inference pipeline. While the text explanation is good, a visual flowchart helps developers and enterprise architects understand the data flow, early exits, and webhook triggers in less than 5 seconds.

✅ Acceptance Criteria

  • Learn Mermaid.js syntax for flowcharts.
  • Create a Mermaid block (```mermaid) in the README replacing the current ASCII diagram.
  • The diagram must accurately depict:
    • User Request -> Stage 1 (Heuristics)
    • Early exit to Block/LLM.
    • Fallback to Stage 2 (Embeddings).
    • Fallback to Stage 3 (Reasoning LLM).
    • Async Webhook dispatch & DB logging.
  • The diagram should be color-coded if possible (e.g., Red for Block, Green for LLM Forward).

📚 Resources

Metadata

Metadata

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomerslevel:beginnerBeginner level - easy issue or PRtype:docsDocumentation change

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions