Skip to content

README.md

Latest commit

 

History

History
63 lines (39 loc) · 2.64 KB

README.md

File metadata and controls

63 lines (39 loc) · 2.64 KB
Raw

@forumone/throughline

A conversational content management framework. Exposes Payload CMS as a set of MCP tools so marketers can operate websites through Claude rather than a traditional admin UI.

Documentation

Full documentation lives at docs/ — getting-started tutorials, conceptual explanations of the architecture, how-to guides, per-package reference, and operations docs. Start at docs/README.md.

Status

1.0. Releases publish under latest, and a snapshot of every merge to main under next. 0.x is closed; its source stays on the v0 branch. See docs/roadmap.md for phase status, and Upgrading from 0.x to 1.0 to move a site.

Packages

Three published packages, released together at one version:

  • @forumone/throughline — throughline(), which registers the suite, and each part on its own subpath: publishing, approvals, the audit log, components, integrations, email, editorial reports, media, the field kit, and background jobs on Inngest or Payload Jobs
  • @forumone/throughline-design-system — the component contract and manifest, its lint, and the manifest's Payload blocks, rendering and admin components
  • @forumone/create-throughline — the scaffolder (pnpm create @forumone/throughline my-site), with the brand-neutral reference design system a new project starts from

Internal, non-published config packages:

  • @forumone/throughline-tsconfig — shared TypeScript configs
  • @forumone/throughline-eslint-config — shared ESLint flat config
  • @forumone/throughline-prettier-config — shared Prettier config

Using in a client project

The fastest path is the scaffolder:

pnpm create @forumone/throughline my-client-site

It asks a small set of questions and produces a pnpm monorepo with Payload, the suite registered by throughline(), and an Inngest endpoint already wired. The full walkthrough is at docs/getting-started/scaffolding-a-project.md.

Or add the packages to a Payload site:

pnpm add @forumone/throughline @forumone/throughline-design-system

See docs/reference/ for the reference.

Development

Requirements: Node.js 20.9+ and pnpm 10+.

pnpm install
pnpm build
pnpm test

Author changes and add a changeset:

pnpm changeset

Open a PR. CI runs build, typecheck, lint, and test. On merge to main, Changesets opens a release PR that publishes to npm on merge.

See CONTRIBUTING.md for details.