docs

start

Introduction: What rapid is, what it makes, and how its parts fit together.
Install: Requirements, the repository, rapid setup, the plugin, and the daemon, by hand.
Your first video: Start a video from a brief with /rapid new or rapid video, give notes, and render the demo project with no agents.

concepts

Projects: A project is a folder; this is every file in it and who writes it.
Scenes: HTML scenes and canvas scenes, the meta, the frame rule, and why every frame renders the same.
Styles and formats: The look and the deliverable as data packages, the kit every style styles, and how a project finds and pins them.
The job graph: Jobs, nodes, edges, fingerprints, staleness, approvals, and the planner that grows a video's graph.
Lanes: How rapid shares one machine between many nodes, and how to set slots per lane.
Review: Code checks first, then a reviewer's marks, in bounded rounds, with your stops; the Mark and Review shapes.

guides

Writing scenes: The HTML scene authoring contract, with small examples that link a style and render in any of them.
Scene libraries: rapid:lib/shots@1, deterministic kinetic primitives for HTML scenes, and the other pinned libraries: camera, motion, fields, shapes, charts, and pictures.
Transitions: The join's named moves between two scenes, what each draws, its settings and eases, and what the element moves ask of a scene.
Music: Cut a video to a track: what rapid listen hears, the map agents plan from, the bed under the video, and the checks that hold it to the beat.
Blender shots: Real product shots from a 3D model: the recipe, the four kinds, the stills judged first, and the clips with alpha a scene plays.
Making a style: Write a style by hand, from its folder, style.json, style.css and the kit, taste.md, and refs, to proving, checking, and packing it.
Extracting a style: Draft a style from stills, clips, live web pages, front-end code, or Figma with rapid style extract, then finish it with the extractor agent.
Sharing styles: Add styles by name from rapid's GitHub repository, or from a folder, a zip, an address, or any repository; pin them in rapid.lock; contribute one with a pull request.
Using the pane: The /rapid command, what the pane shows, the Start daemon button, and the screening page at 127.0.0.1:4317.
Using the MCP tools: The local rapid MCP server's eleven tools, what each is for, when to use them instead of the CLI, and what to ask Claude.

reference

CLI: Every rapid command and option, grouped by what it does.
HTTP API: The daemon's local API and its event stream.
Package files: Every field of Style, Format, Manifest, and rapid.lock, with types and defaults.
FAQ: Short answers to common questions and failures, with links to the pages that say more.