Documentation Maintenance
Docs are part of the product surface. A builder should be able to read the docs, connect an agent through Design MCP, and verify a real app without reverse engineering the repo.
Source layout
Local check
Run:
This checks navigation paths, MDX frontmatter, local MDX links, and OpenAPI template structure.
When to update docs
Update docs when changing:
- Builder UI workflows
- Design MCP endpoints, tools, scopes, or OAuth behavior
- Runtime API generation
- Runtime MCP generated tools
- webhooks, subscriptions, adapters, permissions, or sandbox behavior
- custom page preview, deployment, or runtime behavior
- public surface classification
Agent-readable docs
For agent-facing content, be explicit about:
- exact surface or endpoint
- read-only vs mutation authority
- required scope
- target tenant/app/environment
- safe sequence
- verification gate
An agent should not need to infer whether a page describes design-time or runtime behavior.
Review expectation
Documentation changes that reshape onboarding should receive a builder-persona review. The reviewer should check whether a new builder can connect Design MCP, understand the model, make a scoped change, and verify runtime behavior without hidden assumptions.