Get started

Data model

Teams, projects, documents and categories, and how they fit together.

Everything in PMKIN lives in a project, and every project belongs to a team. Here’s the shape of it:

text
Team
├── Members
└── Project ← a delivery key or management token belongs to one project
├── Categories ← e.g. "Guides", "Changelog"; can be nested
├── Clusters ← topic groups, e.g. "Pricing pages"
└── Documents
├── Brief ← what to write, for people or agents
├── Draft ← markdown you edit, with a version number
├── Published ← what your website gets
└── Revisions ← every saved version

Teams and projects#

A team is who you work with and how you’re billed. A project is one website or publication. Each project has its own documents, categories, clusters and credentials, so a key for your blog can never read your docs site.

Documents#

A document is one page: a blog post, a guide, a changelog entry. Its body is GitHub Flavored Markdown. Besides the body it has a title, slug, subtitle, excerpt, cover image, SEO title and description, a category and a cluster.

Draft and published#

Every document keeps two copies of its content. The draft is what you edit. The published version is what the delivery API serves. Editing a published document doesn’t change your website until you publish again.

Versions#

Every content change bumps the document’s version and is kept as a revision you can restore. The management API and MCP use the version to stop two writers from overwriting each other: a write sends the version it read as baseVersion, and fails if someone else saved in between. Read more in content and edits.

Statuses#

text
idea → planned → drafting → review → scheduled → published

A document moves through these statuses from first idea to live page. An idea is a document with a brief and no content yet. The workflow page covers every transition.

Categories and clusters#

Categories are for readers: they become sections of your site, like “Guides” or “News”, and the delivery API can list the documents in one. Clusters are for planning: a topic and its keywords, with progress on how many of its documents are live. Each document has at most one of each.

What the delivery API sees#

Your website only sees published documents and their categories. Briefs, drafts, statuses, clusters and revisions stay inside PMKIN.

Need a preview of unpublished drafts? The document lists take includeDrafts: true. See pagination and drafts.