Maintaining These Docs
What to update when plugin components change.
Maintaining These Docs
A checklist for keeping the documentation accurate after codebase changes. The most common drift is component counts going stale after adding skills or hooks.
When you add or remove a skill, command, agent, or hook
- Update the plugin's doc page (
claude-core.mdx,dev-engine.mdx, ortaskflow.mdx):- Version/count line at the top
- Component Reference tables at the bottom
- Update
index.mdxcount in the plugin summary - If it's a command, add or remove it from the "All Commands" table in
index.mdx
Cross-check: Count entries in plugins/<plugin>/.claude-plugin/ecosystem.json to verify your numbers match.
When you bump a plugin version
Update the version in:
- The plugin's doc page (version line near the top)
plugins/<plugin>/.claude-plugin/plugin.json(the source of truth)
When directory structure changes
Update:
architecture.mdxState Management tableinit-project.mdx.ai/ directory tree
When you add a new doc page
- Create the MDX file in
docs/with YAML frontmatter (title, description) - Add the page slug to
docs/meta.jsonin the correct sidebar position - Add a "See also" entry on 2-3 related pages that should link to it
- Run
node site/scripts/sync-docs.mjsto copy tosite/content/docs/
When you change MCP integrations
Update:
configure.mdxwith the config snippet and verification steptroubleshooting.mdxif there are known failure modes
Build and deploy
node site/scripts/sync-docs.mjs # sync docs/ to site/content/docs/
cd site && pnpm build # verify all pages renderThe source of truth is docs/*.mdx. Never edit site/content/docs/ directly - those files are overwritten by the sync script.
See also
- Architecture - plugin structure and state management
- Troubleshooting - common issues after changes