Guides
Deploy the docs
Ship this Fumadocs site to docs.trysiphon.dev.
The docs live at apps/docs — a self-contained Next.js app in the monorepo, built
with Fumadocs. It deploys independently of the admin app.
Local development
pnpm --filter @siphon/docs dev # http://localhost:3200
pnpm --filter @siphon/docs build # production buildContent is MDX under apps/docs/content/docs. Sidebar order/grouping is controlled
by meta.json files. Add a page by dropping in a .mdx file with title and
description frontmatter; add it to the nearest meta.json pages array to place
it in the sidebar.
Deploy to Vercel (docs.trysiphon.dev)
- Create a Vercel project pointed at this repo.
- Set Root Directory to
apps/docs. - Framework preset: Next.js (build
next build, installpnpm install). The monorepo workspace resolves@siphon/docs's dependencies automatically. - Add the domain docs.trysiphon.dev to the project and point its DNS
(
CNAME→ Vercel) as instructed.
That's it — pushes to the default branch publish the docs.
Keep the docs current
Documentation is part of "done." When you add or change a feature:
- New spec field or block → update the relevant page under
content/docs/spec/*and the enums reference. - New platform capability (destination, engine behavior, admin surface) → add
or update a page under
content/docs/platform/*. - New enumerated value → add it to Enums & values.
- New endpoint → add a row to the REST API map.
A feature without its docs page isn't finished.