Guide Overview
This guide is organized around decisions, not around package names alone.
If you are new to the generator developer platform, do not start by reading API pages one by one. Start by answering three questions:
- What kind of generator am I building?
- Do I need a custom shell or the official shell?
- Am I building manually or through AI-assisted workflow?
The Platform In One Table
| Layer | Owns | Read when |
|---|---|---|
generator-sdk | Platform capabilities such as auth, billing, export, cloud, history, and template helpers | You need platform APIs inside your generator |
generator-workbench | The official shell UI and standard host layout | You want the platform shell without rebuilding it |
Generator Runtime Contract | The runtime protocol between host and generator | You need full / embed, schema-driven panels, or host-controlled mounting |
generator-sdk-mcp + skills | AI-facing docs lookup and workflow guidance | You want AI to scaffold or refactor generators against the real platform contract |
Recommended Reading Order
If you are evaluating the platform
If you are building through AI
- AI Vibe Coding Workflow
- Generator Onboarding
- Generator Workbench
- Workbench Runtime Communication
- Embed Host Integration
- Generator Workbench Upgrade
- Runtime Contract
If you are integrating the SDK manually
Which Page Answers What
- Read Integration Decision Tree to choose between SDK only, SDK + workbench, custom shell, or AI path.
- Read Developer Journey to see the full delivery path from local prototype to publish-ready generator.
- Read Architecture to understand how local runtime, SDK, workbench, and platform-side release flow fit together.
- Read Generator Workbench to understand what the shell owns and what it must never own.
- Read Workbench Runtime Communication when you need the complete direction map for
workbench <-> runtime, includingrouteMode,select_template, and reverse commands. - Read Embed Host Integration when the main site needs to change iframe timing, bridge wiring, and template bootstrap behavior in
?mode=embed. - Read Generator Workbench Upgrade when existing CDN-based generators need to adopt new shell capabilities safely.
- Read Runtime Contract when you need host/runtime protocol details.
- Read SDK Overview when you need a module map before going into API references.
What This Guide Intentionally Avoids
This guide does not duplicate the detailed API reference.
Once you know which module you need, jump to: