Skip to main content

apps/docs — public API documentation (Mintlify)

The public developer docs site (Mintlify, docs.json, .mdx). The API reference is generated from the oRPC contract in @workspace/contract (OpenAPI → openapi.json). Not a Worker — a Mintlify site. No wrangler.

What it does

  • Hand-written guides: introduction, quickstart, authentication, conventions, migrating-to-people (the contacts→people rollout runbook).
  • openapi.json — generated API reference; regenerate from the contract, don’t hand-edit.
  • Mintlify is documentation only. Keep its API playground proxy disabled and never expose OpenAPI operations through Mintlify MCP (x-mint.mcp.enabled must remain false).
  • The only supported MCP server is the first-party Worker at https://mcp.norbelys.com/mcp.

Scripts

bun run generate (rebuild OpenAPI from contract) · dev · build · validate · broken-links. Module map: docs/our/modules/apps/docs.md. Design/SSOT for the API surface lives in docs/api/ (repo root) and docs/our/29. This app is the rendered public version of that contract.