Docs overview

Every app includes built-in documentation pages at /docs/* that are auto-generated from the app’s code and configuration. These pages are generated deterministically via static analysis at build time — not by AI — so they serve as a reliable source of truth for the app’s API surface, data model, and architecture. They require no app code — they are provided by systemRoutes() and populated from build-time manifests.

Available docs pages

Page	Route	Description
Pages	`/docs/pages`	All app routes with titles, descriptions, auth requirements, and feature tags
API	`/docs/api`	Every tRPC procedure with input/output schemas, scopes, and an interactive playground
Data	`/docs/data`	Database schema with tables, columns, relations, indexes, and RLS access patterns
Services	`/docs/services`	Connected service operations with schemas and cross-references to procedures and workflows
Workflows	`/docs/workflows`	Workflow definitions with schedules, input variables, and interactive DAG visualizations
Visualize	`/docs/visualize`	Full-page interactive architecture diagram of the entire app

Who can access docs

Docs pages are accessible to all authenticated users. They are registered by systemRoutes() and require no additional configuration.

Access verification

Pages Docs

⌘I

Platform Docs

Synthetiq Desktop

Synthetiq CLI

App Framework

Services Framework

Workflows Framework

Platform API

Deployments

Docs overview

Available docs pages

Who can access docs

​Available docs pages

​Who can access docs

Available docs pages

Who can access docs