File conventions
Every file and folder a Startup project holds, with its format, what it compiles to, and the business page it implements.
Each file and folder in a Startup project follows one convention. Each page gives the format, a minimal and a full example, what the file compiles to, and its routes.
Root files
| File | Compiles to |
|---|---|
startup.ts, startup.mdx, startup.json | The Startup |
startups.lock | Version pins |
settings.mdx | Settings |
policies.mdx | Policies |
env.ts | Secret and Integration requirements |
AGENTS.md, .mcp.json, package.json | Coding agent setup |
Nouns and Verbs
| File | Compiles to |
|---|---|
nouns/ | A Noun, its API and types |
nouns/ | The Function behind a Verb |
nouns/ | Checks on every Change |
verbs/ | One Verb on several Nouns |
evaluators/ | An Evaluator |
mappings/ | A Mapping |
Products
| File | Compiles to |
|---|---|
products/ | A Product |
offers/ | An Offer, its Price and checkout |
sites/ | A Site |
**/page.mdx | A Page |
**/layout.mdx | The frame of every Page below |
**/not-found.mdx | The 404 Page |
(group)/, [key]/, _name/, @arm/ | URLs, Collection Pages, Variants |
apps/ | An App |
apps/ | One App screen |
domains/ | A Domain, DNS, certificate, mail |
content/ | Content |
Agents and Workflows
| File | Compiles to |
|---|---|
agents/ | A Team |
agents/ | A Role and its Worker |
agents/ | Autonomy per Verb |
agents/ | A skill package |
workflows/ | A Process |
workflows/ or .ts | Workflows and Triggers |
plays/ | A Play |
experiments/ | An Experiment, its Variants and Flag |
prompts/, [prompt]@[arm].md | Model instructions, as a versioned Template |
Systems, design and code
| File | Compiles to |
|---|---|
systems/ | An override on a System |
dashboards/ | A Dashboard |
brand/ | Brand, Theme, Templates |
components/, .tsx, .css | A Component |
tests/ | Checks on every Change |
code/ | An Implementation |
generated/ | Nothing; the platform writes it |
_name/ | Nothing; unmanaged |
.sb/ | Manifest, resolved Startup, types |