Skip to main content

Documentation Plan

This site is the operating manual for SABLE. It is intentionally separate from the branded engagement deliverables in branded/ and the older wrapped HTML docs in web/docs/.

Audience​

  • Operators: Need deploy, secret, migration, connector, and smoke-test steps.
  • Product users: Need to understand Home, Cockpit, Project Hub, Approvals, Ask SABLE, and Outcome Engine.
  • Engineers: Need architecture, API contracts, schema notes, and function contracts.
  • Client-facing leads: Need a clear explanation of what is real, what is gated, and what comes next.

Information Architecture​

  • Start Here: Overview, quickstart, glossary, and this documentation plan.
  • Product: User-facing app surfaces and expected behavior.
  • Architecture: Runtime structure, spine, managed agents, act layer, and security boundaries.
  • Connectors: Fathom, Asana, Toggl, Drive, HubSpot, and Calendar contracts.
  • Operations: Local dev, deployment, secrets, smoke tests, troubleshooting, and new-client setup.
  • Reference: API routes, Edge Functions, schema, and environment variables.

Maintenance Rules​

  • Update docs in the same branch as any app behavior change.
  • Keep connector docs aligned with sable-agents-demo/CONNECTOR-SETUP.md.
  • Keep schema docs aligned with the latest migration.
  • Do not document secrets by value. Secret names and expected presence are allowed.
  • Mark operator switches clearly, especially anything that can write to external systems.
  • Keep legacy CMA-memory behavior labeled as demo-only.

Release Cadence​

Update the docs whenever any of these change:

  • A web route, Edge Function, or migration is added.
  • A connector changes status, required secret, or request body.
  • A UI page changes what it reads or writes.
  • A production gate is armed or disarmed.
  • Outcome pricing gains a new metric.

Verification Expectations​

Before merging documentation changes:

cd sable-agents-demo/docs-site
npm install
npm run build

The build should fail on broken internal links. Treat that as a feature.