Migration Notes
Breaking changes in the simplified docs usability release.
Migration Notes
This release removes the old per-docs-set security and routing knobs. It does not keep runtime compatibility branches for the removed model.
Admin Records
For each existing docs package:
- Create a docs set in
Docs Globals > Sets. - Use the old source value as the new
slug. - Set the branch, usually
main. - Add a group only when the route needs nesting.
- Add GitHub owner trust in
Docs Globals > Trusted. - Add Ed25519 public keys in
Docs Globals > Keysif local signed pushes are still needed.
Routes are derived from group slugs and the docs set slug. GitHub OIDC audience is derived from the docs set slug.
Removed Setup Knobs
Remove these from docs set records, plugin config, scripts, and docs:
- manual route values
- source root values
- plugin-level source allowlists
- per-set Ed25519 keys
- per-set GitHub repository owner lists
- OIDC audience flags
- OIDC issuer/JWKS/skew options
- workflow restrictions unless advanced security is explicitly enabled
- presentation and SEO placeholder fields
CLI Changes
Use:
1payload-markdown-docs push \2 --endpoint "$DOCS_SYNC_ENDPOINT" \3 --source main-docs \4 --github-oidc
Do not pass route or OIDC audience flags. In GitHub Actions, --source can be
omitted when the repository name is the docs set slug.
Skill-First AI Workflow
AI-facing support now comes from native skill packs instead of the old AI export model.
Removed/deprecated artifacts and runtime paths:
index.ai.ymlindex.ai.yaml- docs set
aiExportJSON - AI export manifest parsing
- raw Markdown export route helpers
payload-markdown-docs.md/plugins/payload-markdown-docs.md
Use repo-local Markdown files under /docs for human documentation source. Use
the canonical skill artifacts under /skills/payload-markdown-docs/<agent>/ for
agent workflow instructions. The CLI installer copies those artifacts into
project-local agent paths for Codex and Claude.
