Proposal: Adding Mermaid diagrams to visualize Typer's CLI workflow

[maxkrivachev-web]

Hi everyone!

I've been a fan of Typer for a while, and I love how it makes CLI development so intuitive.

I noticed that while the documentation is great, it could benefit from some visual aids to explain the "magic" behind the scenes—specifically how Typer maps type hints to CLI arguments and handles the validation flow.

I propose adding interactive Mermaid.js diagrams to the docs. Typer is a very visual-friendly library, and adding diagrams matches this aesthetic perfectly.

You can see my documentation portfolio here: https://github.com/maxkrivachev-web/portfolio/tree/main/cases/obsidian-html

I’d be happy to submit a PR if the community finds this useful!

Proposed Workflow Diagram:

graph LR
    Input[User Input] --> App{Typer App}
    App --> Hints[Type Hint Analysis]
    Hints --> Valid{Validation}
    Valid -->|Success| Exec[Execute Function]
    Valid -->|Fail| Help[Show Rich Help]

Loading