Developer documentation for Orbit: non-custodial pull payments and atomic batch payroll on Stellar Soroban.
This repo holds the documentation site. The protocol code lives in Orbit-xyz/Orbit.
content/docs/ # all pages (MDX)
index.mdx # introduction (served at /)
quickstart.mdx, testnet.mdx, roadmap.mdx
concepts/ # allowance vaults, trust model
checkout/ # hosted checkout, widget
subscriptions/ # plans, billing cycles
payroll/ # batch payroll
contracts/ # OrbitContract entrypoint reference
api-reference/ # Merchant API endpoints, errors, webhooks
meta.json # sidebar order and section headers
components/mdx.tsx # Note, Warning, Steps, Tabs, Cards, ParamField, Endpoint...
components/mermaid.tsx # client-side Mermaid diagrams (theme-aware)
lib/ # source loader, nav config
public/openapi.yaml # Merchant API spec
Pages use Mintlify-style components (<Note>, <AccordionGroup>, <Steps>, <Tabs>, <Columns>, <ParamField>), mapped onto Fumadocs in components/mdx.tsx.
npm install
npm run dev # http://localhost:3000
npm run types:check # generated routes and TypeScript validation
npm run build # production build, validates every docs pageSearch (Ctrl K), llms.txt, llms-full.txt and per-page Markdown (/<page>.md) are built in.
Pull requests and pushes to main run these checks on Node.js 20 using npm ci in GitHub Actions. Fix failing type generation, TypeScript, or MDX compilation before merging.
Live at orbit-docs-eta.vercel.app. Deployed on Vercel as its own project, and every push to main redeploys.
- Token amounts are raw integer units (USDC has 7 decimals,
290000000= 29 USDC). - Every code sample must run against testnet contract
CAZBZBUWBSQYK2RZ6WHMXVDLIQHSU5WD7ANZYL6HLNSCRUOTNYCDYQNG. - Mark anything not yet live as preview or planned.
- Monochrome brand:
#000000,#FFFFFF,#2C2C2C.
MIT. Orbit Contributors.