When creating or modifying plugins or skills, ensure corresponding VitePress documentation pages exist and are up to date.
Plugin Changes
When a plugin is added or modified in packages/plugins/:
Ensure docs/plugins/{plugin-name}.md exists and reflects the current state
Update docs/plugins/index.md to include the plugin in the table
Run node scripts/validate-docs.cjs to verify
Skill Changes
When a skill is added or modified in packages/plugins/*/skills/:
Ensure docs/skills/{skill-name}.md exists and reflects the current state
Update docs/skills/index.md to include the skill in the appropriate plugin section
Run node scripts/validate-docs.cjs to verify
Doc Page Format
Plugin and skill doc pages use YAML frontmatter with title and order fields. The VitePress sidebar auto-generates from these files.
Validation
Run node scripts/validate-docs.cjs before committing changes to plugins or skills. This is also enforced in CI via the validate-docs job.
1---2name: 426-documentation-fa1f19313description: Documentation Sync Rules4---5# Documentation Sync Rules67## When to Update VitePress Docs89When creating or modifying plugins or skills, ensure corresponding VitePress documentation pages exist and are up to date.1011### Plugin Changes1213When a plugin is added or modified in `packages/plugins/`:14151. Ensure `docs/plugins/{plugin-name}.md` exists and reflects the current state162. Update `docs/plugins/index.md` to include the plugin in the table173. Run `node scripts/validate-docs.cjs` to verify1819### Skill Changes2021When a skill is added or modified in `packages/plugins/*/skills/`:22231. Ensure `docs/skills/{skill-name}.md` exists and reflects the current state242. Update `docs/skills/index.md` to include the skill in the appropriate plugin section253. Run `node scripts/validate-docs.cjs` to verify2627### Doc Page Format2829Plugin and skill doc pages use YAML frontmatter with `title` and `order` fields. The VitePress sidebar auto-generates from these files.3031### Validation3233Run `node scripts/validate-docs.cjs` before committing changes to plugins or skills. This is also enforced in CI via the `validate-docs` job.
Run npx skillmds@latest add tools-only/426-documentation-fa1f1931 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
Documentation Sync Rules It is listed under Docs & Writing on SkillMD.
This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
tools-only (@tools-only) published this skill. Their other Agent Skills are listed on their SkillMD profile.