Quick Start

This quick start assumes the conventional docs package layout and a docs set slug of main-docs.

Create Admin Records

In Docs Globals > Sets, create:

• title: Main Docs
• slug: main-docs
• branch: main
• optional group: a group such as plugins when you want nested routes

In Docs Globals > Access, create a GitHub OIDC record:

• type: GitHub OIDC
• owner: your GitHub owner or organization
• limitRepos: off for the normal owner-level trust model

The set slug is the manifest source. The route base is derived from the optional group and the set slug.

Source Layout

1docs/2  index.md3skills/4  main-docs/5    codex/6      SKILL.md7    claude/8      SKILL.md

Markdown docs become manifest files. Skills become manifest assets, so skill files do not need docs frontmatter. AI discovery files are generated from synced docs, docs set metadata, dependencies, and skills.

Install An Agent Skill

In the docs set target application, install local agent skills so Codex or Claude has project-specific guidance for package structure, supported frontmatter, validation, sync safety rules, and Payload Markdown authoring.

1pmdocs install skill --agent codex2pmdocs install skill --agent claude

The Codex installer writes .agents/skills/payload-markdown-docs/ and .agents/skills/payload-markdown/. The Claude installer writes .claude/skills/payload-markdown-docs/ and .claude/skills/payload-markdown/. These installs do not sync docs, call Payload, or publish content.

Install Public Asset Routes

If the consuming Next app should serve generated /llms.txt, /llms-full.txt, docs-set llms files, or skill URLs outside /api, commit the generated route files:

1pmdocs install routes --payload-app "src/app/(payload)"

Those route files delegate to the plugin-owned asset handlers. Without them, a frontend catch-all can return HTML 404 pages even when /api/... asset URLs work.

Validate Local Docs

1pmdocs validate --source main-docs

Generate A Manifest

1pmdocs manifest --source main-docs --pretty

Preview A Plan

1pmdocs plan --source main-docs

Push From GitHub Actions

1pmdocs push \2  --endpoint "$DOCS_SYNC_ENDPOINT" \3  --source main-docs \4  --github-oidc

This quick start passes --source main-docs explicitly because copied GitHub Actions workflow templates should name the intended docs set instead of relying on repository-name inference.

To publish during sync, add --publish and make sure the server allows publishing. See publishing.