Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Throughline documentation

Throughline is a conversational content management framework. It exposes a Payload CMS application as a constellation of MCP servers so marketers can operate the site through Claude rather than a traditional admin UI.

If you want a one-page mental model: read Architecture overview. If you want to ship something: jump to Scaffolding a project.

Sections

The docs follow the Diátaxis framework. Each section answers a different kind of question.

  • Getting started — tutorials. Start here if you've never built a Throughline project. End-to-end, learn-by-doing, ~30 minutes from pnpm create to "Claude editing a page."
  • Concepts — explanations. Read these to understand why the system is shaped the way it is. The trust boundary, plugin composition, design system contracts, event-driven workflows.
  • Guides — how-tos. Specific tasks with concrete steps. Add a collection, theme an email, write a custom accessibility check.
  • Reference — API reference for every published package. Look up types, options, exported functions.
  • Operations — deployment, environment variables, observability, security model, the Phase 2 roadmap.
  • Spec — the original phased build plan (C0 through C14). Useful if you're contributing to the framework itself.

Audiences

What Throughline gives you

  • Edit pages through conversation. "Update the homepage hero to focus on the new climate program." Claude calls Payload MCP under the hood.
  • Compose with a real design system. The Components MCP server reasons about your DS — when to use Hero vs SectionIntro, what variants fit which intent, what compositions break editorial rules.
  • Publish with governance. The Publishing MCP server enforces accessibility, approval workflows, scheduled publishing, and embargo policies automatically. Direct _status writes are blocked.
  • Approve from your inbox. Approvers receive emails with inline action buttons. No CMS login required to sign off on a change.
  • Connect to anything. The Integrations MCP server's plugin architecture makes CRM, marketing automation, and analytics connections straightforward.

Status

Pre-1.0. APIs will change before 1.0. Track progress in roadmap.md.

Naming note

The original specs (under docs/spec/) refer to packages as @forumone/claude-cms-*. The actual published packages use throughline. Mentally substitute when reading the specs.