58 lines (40 loc) · 2.92 KB

Vant Flow — Documentation

This index is organized by what you are trying to do. Pick your path.

I want to use the library in my app

README → Quick Start — install, register, render your first form in 5 minutes
README → Core Concepts — understand DocumentDefinition, the frm API, and host inputs
Renderer Architecture — deep reference for all renderer inputs, outputs, and hook points
Business Use Cases — real-world patterns: approvals, KYC, inspections, work orders

Sample schemas to import and experiment with:

I want to understand how it is built

Architecture Overview — the full platform: library, renderer, builder, frm context, MCP
Renderer Architecture — how the renderer evaluates schema, scripts, and host inputs
Builder Architecture — how the visual builder works and how schemas are authored
Example Showcase Architecture — how the reference app is structured
MCP Architecture — how the MCP server exposes Vant Flow to AI agents

I want to contribute

CONTRIBUTING.md — setup, repo orientation, PR checklist, commit conventions
Architecture Overview — understand the full system before diving into code
Builder Architecture or Renderer Architecture — dive into the area you are working on

I want to integrate AI or MCP tooling

MCP Architecture — how the MCP server is structured and how to add tools
Architecture Overview — how vant-mcp sits alongside the library
Example Showcase Architecture — how the demo proxy connects AI to the builder

All documents

Document	Description
Architecture Overview	Full platform architecture
Builder Architecture	Visual schema builder internals
Renderer Architecture	Runtime renderer, inputs, hooks, and scripting
MCP Architecture	AI/MCP server tooling
Example Showcase Architecture	Reference application structure
Business Use Cases	Real-world pattern reference