# Documentation Sitemap ## Purpose This file is a high-level semantic index of the documentation. It is intended for: - LLM-assisted navigation (ChatGPT, Claude, etc.) - Quick orientation for contributors - Identifying relevant documentation areas during development It is not intended to replace individual docs. --- - [Overview](/docs) | Type: Overview | Lastmod: 2026-08-06 | Summary: What OPB Brain is, what runs in the repository today, and what is still only designed. - [Agent Experience](/docs/agent-experience) | Type: Conceptual | Lastmod: 2026-07-24 | Summary: The eight AX rules that gate review on any agent-facing surface, why each exists, and the review checklist they produce. | Prerequisites: Overview | Topics: agent-experience - [Architecture](/docs/architecture) | Type: Conceptual | Lastmod: 2026-08-06 | Summary: Map of the OPB Brain monorepo — seven applications, twenty shared packages, the boundaries rule between them, and which parts of the design have no code yet. | Prerequisites: Overview | Topics: architecture - [Concepts](/docs/concepts) | Type: Conceptual | Lastmod: 2026-08-06 | Summary: Index of the OPB Brain domain model — the entity map, the record conventions shared by every table, and the invariants the service layer is designed to hold. | Prerequisites: Overview | Topics: concepts - [Agents and machines](/docs/concepts/agents-and-machines) | Type: Conceptual | Lastmod: 2026-07-24 | Summary: The identity layer of the domain — workspace tenancy, user roles, the Agent record, the Machine that runs it, heartbeat-derived status, and scoped tokens. | Prerequisites: Concepts | Topics: concepts, agents-and-machines - [Approvals and leasing](/docs/concepts/approvals-and-leasing) | Type: Conceptual | Lastmod: 2026-07-24 | Summary: The lease protocol that hands work to one runner at a time and reclaims it when the runner dies, and the Approval record that blocks a task until a human decides. | Prerequisites: Concepts | Topics: concepts, approvals-and-leasing - [Documents and artifacts](/docs/concepts/documents-and-artifacts) | Type: Conceptual | Lastmod: 2026-07-24 | Summary: The Document record that holds decisions, runbooks and ADRs, the content-addressed Artifact record that holds diffs, logs and screenshots, and the rule for choosing between them. | Prerequisites: Concepts | Topics: concepts, documents-and-artifacts - [Runs and events](/docs/concepts/runs) | Type: Conceptual | Lastmod: 2026-07-24 | Summary: The Run record, the append-only Event timeline, comments, and the write-back contract a remote runner must honour. | Prerequisites: Concepts | Topics: concepts, runs - [Tasks](/docs/concepts/tasks) | Type: Conceptual | Lastmod: 2026-07-24 | Summary: Task fields, how tasks form a DAG, and the full task state machine with its legal transitions and server-side guards. | Prerequisites: Concepts | Topics: concepts, tasks - [Design and UX](/docs/design) | Type: Guide | Lastmod: 2026-08-04 | Summary: Start here before changing any user-facing OPB Brain surface. | Prerequisites: Overview | Topics: Design System, design - [Accessibility](/docs/design/accessibility) | Type: Guide | Lastmod: 2026-08-04 | Summary: WCAG 2.2 AA is the floor for every surface in both themes. | Prerequisites: Design and UX | Topics: Design System, design, accessibility - [Agent-facing rendering](/docs/design/agents) | Type: Guide | Lastmod: 2026-08-01 | Summary: Make every browser surface discoverable and actionable for an agent with no context. | Prerequisites: Design and UX | Topics: Design System, design, agents - [Components](/docs/design/components) | Type: Reference | Lastmod: 2026-08-01 | Summary: Compose existing primitives and consume the normative component recipes. | Prerequisites: Design and UX | Topics: Design System, design, components - [Layout](/docs/design/layout) | Type: Guide | Lastmod: 2026-08-04 | Summary: Spend space according to the register and keep information visible. | Prerequisites: Design and UX | Topics: Design System, design, layout - [Motion](/docs/design/motion) | Type: Reference | Lastmod: 2026-08-04 | Summary: Motion explains a state change and never delays information. | Prerequisites: Design and UX | Topics: Design System, design, motion - [Patterns](/docs/design/patterns) | Type: Guide | Lastmod: 2026-08-01 | Summary: Use the canonical composition for recurring interface problems. | Prerequisites: Design and UX | Topics: Design System, design, patterns - [Tokens](/docs/design/tokens) | Type: Reference | Lastmod: 2026-08-04 | Summary: Consume the complete token catalogue without copying resolved values. | Prerequisites: Design and UX | Topics: Design System, design, tokens - [Typography](/docs/design/typography) | Type: Reference | Lastmod: 2026-08-04 | Summary: Use sans for interface, serif for reading, and mono for machine truth. | Prerequisites: Design and UX | Topics: Design System, design, typography - [Voice](/docs/design/voice) | Type: Guide | Lastmod: 2026-08-01 | Summary: Write exact, factual copy that lets a human or agent act without guessing. | Prerequisites: Design and UX | Topics: Design System, design, voice - [Structure](/docs/structure) | Type: Conceptual | Lastmod: 2026-08-06 | Summary: How the monorepo, apps, and packages are organized. | Prerequisites: Overview | Topics: structure - [API](/docs/apps/api) | Type: Reference | Lastmod: 2026-08-06 | Summary: The API application, its four current routes, and the agent-facing surfaces designed to be built on top of it. | Topics: API, apps, api - [App](/docs/apps/app) | Type: Reference | Lastmod: 2026-08-06 | Summary: The authenticated application shell, the routes it serves today, and the browser interface it is designed to grow into. | Topics: App, apps, app - [Documentation](/docs/apps/docs) | Type: Reference | Lastmod: 2026-08-06 | Summary: Why there are two documentation projects, which one is current, and how to add a page to it. | Topics: Docs, apps, docs - [Email](/docs/apps/email) | Type: Reference | Lastmod: 2026-08-06 | Summary: The local preview server for email templates, and where the templates themselves live. | Topics: Email, apps, email - [Storybook](/docs/apps/storybook) | Type: Reference | Lastmod: 2026-07-24 | Summary: The component workshop, what it is configured with, and how to add a story. | Topics: Storybook, apps, storybook - [Studio](/docs/apps/studio) | Type: Reference | Lastmod: 2026-08-06 | Summary: The local visual database editor, and what it currently has to show. | Topics: Studio, apps, studio - [Web](/docs/apps/web) | Type: Reference | Lastmod: 2026-08-06 | Summary: The marketing site, what it is connected to, and why it holds no credentials for anything the product stores. | Topics: Web, apps, web - [Deploying to Cloudflare](/docs/deployment/cloudflare) | Type: Guide | Lastmod: 2026-08-06 | Summary: OPB Brain deploys as six Cloudflare Workers — opb-brain-web, opb-brain-app, opb-brain-api and opb-brain-docs through the OpenNext adapter, plus opb-brain-storybook and opb-brain-email as static assets — backed by D1, R2 and KV bindings rather than connection strings. | Prerequisites: /docs/setup/env | Topics: deployment, cloudflare - [Connect a Remote Agent](/docs/guides/connect-a-remote-agent) | Type: Guide | Lastmod: 2026-07-24 | Summary: Intended runbook for wiring a remote Claude Code or Codex session to OPB Brain over MCP, from machine enrollment to run close-out. None of it is built yet. | Prerequisites: /docs/agent-experience | Topics: guides, connect-a-remote-agent - [Browser](/docs/interfaces/browser) | Type: Reference | Lastmod: 2026-07-24 | Summary: The browser interface into OPB Brain, designed so an agent driving Chrome over CDP is a first-class caller rather than a scraper, and what of it exists today. | Topics: interfaces, browser - [GraphQL API](/docs/interfaces/graphql) | Type: Reference | Lastmod: 2026-07-24 | Summary: The GraphQL interface into OPB Brain, covering the published SDL, Relay conventions, mutation payload types with typed userErrors, idempotency as an input, subscriptions and cost control. | Topics: interfaces, graphql - [MCP Server](/docs/interfaces/mcp) | Type: Reference | Lastmod: 2026-08-06 | Summary: The MCP door into OPB Brain, covering tool design rules, the tool surface with arguments and returns, resources and prompts, authentication, and the write-back contract. | Topics: interfaces, mcp - [REST API](/docs/interfaces/rest) | Type: Reference | Lastmod: 2026-07-24 | Summary: The REST interface into OPB Brain, covering versioning, discovery, authentication and scopes, idempotency, optimistic concurrency, pagination, realtime and the token-lean response views. | Topics: interfaces, rest - [Product Analytics](/docs/packages/analytics/product) | Type: Reference | Lastmod: 2026-07-24 | Summary: How product analytics captures events and metrics. | Topics: Analytics, packages, analytics - [Web Analytics](/docs/packages/analytics/web) | Type: Reference | Lastmod: 2026-07-30 | Summary: How web analytics captures pageviews and custom events. | Topics: Analytics, packages, analytics - [Authentication](/docs/packages/authentication) | Type: Reference | Lastmod: 2026-08-06 | Summary: How Clerk handles authentication and user management. | Topics: Authentication, packages, authentication - [Components](/docs/packages/cms/components) | Type: Reference | Lastmod: 2026-07-24 | Summary: Components included with the CMS package. | Topics: CMS, packages, cms - [Metadata](/docs/packages/cms/metadata) | Type: Reference | Lastmod: 2026-07-24 | Summary: How title, description, and Open Graph images are configured. | Topics: CMS, packages, cms - [Overview](/docs/packages/cms/overview) | Type: Reference | Lastmod: 2026-07-24 | Summary: How the CMS package is configured. | Topics: CMS, packages, cms - [Collaboration](/docs/packages/collaboration) | Type: Reference | Lastmod: 2026-07-24 | Summary: The collaboration package, the Liveblocks engine behind it, and the avatar stack and live cursors it renders in apps/app. | Topics: Collaboration, packages, collaboration - [Cron Jobs](/docs/packages/cron) | Type: Reference | Lastmod: 2026-08-06 | Summary: How scheduled work runs as a Cloudflare Workers Cron Trigger against a route in apps/api. | Topics: Cron, packages, cron - [Database](/docs/packages/database) | Type: Reference | Lastmod: 2026-08-06 | Summary: The database package uses raw D1 at runtime; Prisma schema and migrations remain for tooling. | Topics: Database, packages, database - [Colors](/docs/packages/design-system/colors) | Type: Reference | Lastmod: 2026-08-01 | Summary: This published URL now points to the normative design token catalogue. | Topics: Design System, packages, design-system - [Components](/docs/packages/design-system/components) | Type: Reference | Lastmod: 2026-08-01 | Summary: This published URL now points to the current component contract. | Topics: Design System, packages, design-system - [Dark mode](/docs/packages/design-system/dark-mode) | Type: Guide | Lastmod: 2026-08-01 | Summary: This published URL now points to the normative theme token catalogue. | Topics: Design System, packages, design-system - [Provider](/docs/packages/design-system/provider) | Type: Reference | Lastmod: 2026-08-01 | Summary: This published URL now points to the current component and screen-building contract. | Topics: Design System, packages, design-system - [Typography](/docs/packages/design-system/typography) | Type: Reference | Lastmod: 2026-08-01 | Summary: This published URL now points to the normative typography guide. | Topics: Design System, packages, design-system - [Transactional Emails](/docs/packages/email) | Type: Reference | Lastmod: 2026-07-30 | Summary: How transactional emails are configured and sent. | Topics: Email, packages, email - [Feature Flags](/docs/packages/flags) | Type: Reference | Lastmod: 2026-08-06 | Summary: How feature flags control access to features. | Topics: Flags, packages, flags - [Formatting](/docs/packages/formatting) | Type: Reference | Lastmod: 2026-07-24 | Summary: How code formatting and linting are configured. | Topics: Formatting, packages, formatting - [Internationalization](/docs/packages/internationalization) | Type: Guide | Lastmod: 2026-07-24 | Summary: How to add multiple languages to your application. | Topics: Internationalization, packages, internationalization - [Bundle Analysis](/docs/packages/next-config/bundle-analysis) | Type: Guide | Lastmod: 2026-07-30 | Summary: How to analyze and optimize your app's bundle size. | Topics: Next Config, packages, next-config - [Configuration](/docs/packages/next-config/overview) | Type: Reference | Lastmod: 2026-07-24 | Summary: How the shared Next.js configuration package works. | Topics: Next Config, packages, next-config - [Notifications](/docs/packages/notifications) | Type: Reference | Lastmod: 2026-07-24 | Summary: How in-app notifications are configured for users. | Topics: Notifications, packages, notifications - [Debugging](/docs/packages/observability/debugging) | Type: Reference | Lastmod: 2026-07-24 | Summary: How debugging is configured across the monorepo applications. | Topics: Observability, packages, observability - [Error Capture](/docs/packages/observability/error-capture) | Type: Reference | Lastmod: 2026-08-06 | Summary: Structured console errors for Cloudflare Workers Observability. | Topics: Observability, packages, observability - [Logging](/docs/packages/observability/logging) | Type: Reference | Lastmod: 2026-08-06 | Summary: Structured console logging drained by Cloudflare Workers Observability. | Topics: Observability, packages, observability - [Uptime Monitoring](/docs/packages/observability/uptime) | Type: Reference | Lastmod: 2026-08-06 | Summary: Prefer Cloudflare Health Checks / Status over Better Stack. | Topics: Observability, packages, observability - [Payments](/docs/packages/payments) | Type: Reference | Lastmod: 2026-07-24 | Summary: How payments and billing are configured with Stripe. | Topics: Payments, packages, payments - [Application Security](/docs/packages/security/application) | Type: Reference | Lastmod: 2026-07-24 | Summary: Security measures that protect your applications. | Topics: Security, packages, security - [Dependency Security](/docs/packages/security/dependencies) | Type: Reference | Lastmod: 2026-07-27 | Summary: The Dependabot configuration in this repository and the secret-scanning tools that are not yet enabled. | Topics: Security, packages, security - [Security Headers](/docs/packages/security/headers) | Type: Reference | Lastmod: 2026-07-30 | Summary: Security headers used to protect your application. | Topics: Security, packages, security - [IP Geolocation](/docs/packages/security/ip-geolocation) | Type: Reference | Lastmod: 2026-07-24 | Summary: How to access IP geolocation data in your application. | Topics: Security, packages, security - [Rate Limiting](/docs/packages/security/rate-limiting) | Type: Reference | Lastmod: 2026-08-06 | Summary: How rate limiting protects your API routes from abuse using Workers KV. | Topics: Security, packages, security - [JSON-LD](/docs/packages/seo/json-ld) | Type: Reference | Lastmod: 2026-07-24 | Summary: How JSON-LD structured data is implemented. | Topics: SEO, packages, seo - [Metadata](/docs/packages/seo/metadata) | Type: Reference | Lastmod: 2026-07-24 | Summary: How to customize page metadata for SEO. | Topics: SEO, packages, seo - [Sitemap](/docs/packages/seo/sitemap) | Type: Reference | Lastmod: 2026-07-24 | Summary: How the sitemap is generated for the website. | Topics: SEO, packages, seo - [Storage](/docs/packages/storage) | Type: Reference | Lastmod: 2026-08-06 | Summary: How file storage is configured on Cloudflare R2. | Topics: Storage, packages, storage - [Inbound Webhooks](/docs/packages/webhooks/inbound) | Type: Reference | Lastmod: 2026-08-06 | Summary: How to receive inbound webhooks from other services. | Topics: Webhooks, packages, webhooks - [Outbound Webhooks](/docs/packages/webhooks/outbound) | Type: Reference | Lastmod: 2026-07-24 | Summary: How to send outbound webhooks to your users with Svix. | Topics: Webhooks, packages, webhooks - [Environment Variables](/docs/setup/env) | Type: Reference | Lastmod: 2026-08-06 | Summary: How environment variables are configured and used across the monorepo, and which of them are actually required to boot. | Prerequisites: /docs/setup/prerequisites | Topics: setup, env - [Prerequisites](/docs/setup/prerequisites) | Type: Guide | Lastmod: 2026-08-06 | Summary: Bun, Node and the optional CLIs the monorepo uses, plus the accounts behind the integrations that are wired into it. | Topics: setup, prerequisites - [Quickstart](/docs/setup/quickstart) | Type: Guide | Lastmod: 2026-08-06 | Summary: From a fresh clone to running dev servers, with the two services needed to boot and the ports each application listens on. | Prerequisites: /docs/setup/prerequisites | Topics: setup, quickstart