Start Here
Start Here
The recommended learning path for understanding and adopting ToonUI from first contact to confident usage.
If you feel lost, start HERE.
This is the recommended ToonUI learning path from beginning to end.
The right order
Follow these pages in this exact sequence:
- Overview — understand what ToonUI is and what it is NOT
- Choose Your Integration Path — decide package path, framework path, and AI loop
- Installation — choose the correct package path
- Quickstart — make ToonUI work end to end
- Configuration — understand the main moving parts
- Mental Model — learn the architecture boundary
- Syntax — learn the core writing rules
- Node Reference — understand when to use each node
- AI Authoring Rules — learn how models should behave
- Complete Syntax Reference — use as deep reference, not as first reading
What to read first vs later
| Read first | Read later |
|---|---|
| Overview | Full Generated Prompt |
| Installation | Catalog |
| Quickstart | Protocol and Types |
| Configuration | React Runtime and Hooks |
| Mental Model | Errors and Validation |
| Syntax | CLI |
The correct mindset
Do NOT start with:
- full syntax reference
- prompt internals
- low-level reference pages
- every package page at once
Start with the flow that gets ToonUI working first.
Then deepen your understanding.
If you are in a hurry
Use this minimal path:
If you want to truly understand ToonUI
Use this full path:
- Overview
- Choose Your Integration Path
- Mental Model
- Boundaries
- Installation
- Quickstart
- Configuration
- Syntax
- Node Reference
- AI Authoring Rules
What comes after this path
After the core learning path, choose based on your goal:
- Need package decisions? → @toon-ui/core, @toon-ui/toon-ui, @toon-ui/react
- Need a real end-to-end example? → Build a Real ToonUI Flow
- Need your own chat loop? → Custom Host Loop
- Need a Vercel-specific integration? → Vercel AI SDK guide
- Need a custom React UI layer? → Custom Adapter
- Need help choosing the right nodes? → UI Patterns
- Need debugging help? → Debug Invalid ToonUI
- Need deep reference? → Reference
Next step
Go to Choose Your Integration Path.