Agent Skill Installer
Install native agent workflow packs for maintaining payload-markdown-docs documentation.
Agent Skill Installer
The installer copies native agent workflow packs from the package skills/
directory into a consuming project.
Codex:
1pnpm exec payload-markdown-docs install skill --agent codex2pnpm exec payload-markdown-docs install skill --codex
Claude:
1pnpm exec payload-markdown-docs install skill --agent claude2pnpm exec payload-markdown-docs install skill --claude
Alias:
1pnpm exec payload-markdown-docs install ai-skill --agent codex2pnpm exec payload-markdown-docs install ai-skill --agent claude
The installer writes Markdown guidance files. Codex installs create or update
AGENTS.md by default so Codex can discover the skill. Claude installs do not
touch AGENTS.md by default. The installer does not sync docs, call Payload,
fetch remote docs, or run package manager commands.
Output Trees
Codex default output:
1.agents/2 skills/3 payload-markdown-docs/4 SKILL.md5 reference/6 payload-markdown-directives.md7 formatting.md8 frontmatter.md9 workflow.md10 sync.md11 routing.md12 admin.md13 troubleshooting.md14 examples/15 docs-page.md16 github-actions.md17AGENTS.md
Claude default output:
1.claude/2 skills/3 payload-markdown-docs/4 SKILL.md5 reference/6 payload-markdown-directives.md7 formatting.md8 frontmatter.md9 workflow.md10 sync.md11 routing.md12 admin.md13 troubleshooting.md14 examples/15 docs-page.md16 github-actions.md
The canonical source artifacts live in the package repository:
1skills/payload-markdown-docs/codex/2skills/payload-markdown-docs/claude/
install skill installs local agent guidance only. It does not publish skills,
sync docs, install public routes, or call Payload.
Publishing Skill Assets
Those directories are safe to publish through the docs site. After
payload-markdown-docs push syncs them as assets, the plugin serves the
standard routes:
1/plugins/payload-markdown-docs/llms.txt2/plugins/payload-markdown-docs/llms-full.txt3/plugins/payload-markdown-docs/skills/codex4/plugins/payload-markdown-docs/skills/codex/SKILL.md5/plugins/payload-markdown-docs/skills/claude6/plugins/payload-markdown-docs/skills/claude/SKILL.md7/plugins/payload-markdown-docs/skills/codex/reference/workflow.md
payload-markdown-docs push publishes these skill artifacts by convention when
they live under ./skills/<source>/. They are sent as manifest assets, not as
docs records, so skill files do not need docs frontmatter.
Installing Public Asset Routes
For Next apps where the frontend catch-all owns those root URLs, install the public asset route files once:
1pnpm exec payload-markdown-docs install routes --payload-app "src/app/(payload)"
Commit and deploy the generated files. If they are missing, /api/... asset
URLs can work while public /llms.txt and /skills URLs return HTML 404 pages.
Discovery
Include exposed skill artifacts in sitemap.xml with stored asset sitemap
coverage or the sitemap helper additionalRoutes option. The plugin also owns
top-level /llms.txt and /llms-full.txt asset handlers so crawlers can
discover the static AI entrypoints while agents can consume the native skill
files directly through public route files.
sitemap.xml is crawler discovery, llms.txt is an AI-readable entrypoint, and
skills are native workflow artifacts.
Options
1pnpm exec payload-markdown-docs install skill --agent codex \2 --out .agents/skills/payload-markdown-docs \3 --docs-root ./docs \4 --package-manager pnpm
Use --dry-run to preview files and --force to overwrite changed existing
skill files. Unchanged existing files are accepted.
What The Skills Teach
- maintain docs in repo-local Markdown files
- use
.mdfiles only unless future config explicitly enables another format - use supported frontmatter only
- follow plain Markdown formatting expectations first
- use supported
payload-markdowndirectives only when useful - keep internal links route-aware and root-relative inside the docs set
- run validate before finishing docs edits
- run plan when sync behavior matters
- use
pushonly when explicitly requested - use
--dry-runonly for explicit dry-run checks - respect server-owned sync, publish, and hard-delete gates
- avoid unsupported features and invented directives
The source split is deliberate: /docs is human documentation source rendered
with Payload Markdown, while /skills is the agent-native workflow package.
