Sume Docs

Standalone developer documentation app for Sume Public API, CLI, MCP, and agent workflows.

This app is based on the MIT-licensed Railway docs codebase, with Sume-specific content, branding, navigation, and deployment assumptions.

Local Development

pnpm install
pnpm dev

The dev server defaults to:

http://localhost:3001

Useful scripts:

pnpm tsc
pnpm build
pnpm start

Content Structure

content/docs/               Markdown docs pages
public/api/openapi.json     Local Sume Public API OpenAPI snapshot
src/data/sidebar.ts         Sidebar navigation
src/pages/index.tsx         Docs home page
src/pages/api/llms*.ts      LLM-friendly docs exports

Add a new docs page by creating a Markdown file under content/docs/ and adding it to src/data/sidebar.ts.

OpenAPI

The preview serves a local schema snapshot at:

/api/openapi.json

Production Sume serves the live schema from:

https://www.sume.so/api/v1/openapi.json

This app intentionally does not embed an interactive OpenAPI renderer. Keep API reference content as normal docs pages unless Sume explicitly chooses a separate API reference surface later.

Vercel Deployment

No environment variables are required for the basic docs app.

Recommended Vercel settings:

Framework: Next.js
Install command: pnpm install --frozen-lockfile
Build command: pnpm build
Output: Next.js default

Optional:

NEXT_PUBLIC_SUME_DOCS_URL=https://docs.sume.so

License

MIT. Portions of the application shell are derived from Railway's MIT-licensed docs app. Preserve the Railway copyright notice in LICENSE.