Back to Skills

documentation-update

Regenerates documentation files (agents.md, agent-skills.md, plugins.md, usage.md) from marketplace data using Jinja templates. Use when plugins are added, updated, or removed to keep documentation in sync.

8stars2forksUpdated 8/17/2026

Security Assessment

Safe(95/100)
Security Score95/100

About documentation-update

This skill keeps a plugin marketplace's documentation in sync with its catalog by regenerating four Markdown files (agents.md, agent-skills.md, plugins.md, usage.md) from marketplace data using Jinja2 templates. It solves documentation drift: as plugins are added, updated, or removed, hand-maintained reference docs fall out of date, so the skill treats marketplace.json as the single source and rebuilds the docs deterministically from it.

The skill bundles a Python script, doc_generator.py, and four Jinja2 templates in assets/. The script loads and validates marketplace.json, scans plugin files to read agent and command frontmatter and skill metadata, builds a comprehensive component index, prepares a template context (marketplace data, plugins grouped by category, flat lists of all agents, skills, and commands, plus aggregate stats), and renders the templates into the docs/ directory. It supports command-line options to generate all files or a specific one, a --dry-run that shows output without writing, and custom paths for the marketplace file, templates, and output directory. Documented error handling covers a missing marketplace file, missing templates, invalid plugin structure, and frontmatter parse errors. The intended integration is automatic invocation after the create/update plugin commands, so regenerated docs are ready to commit alongside plugin changes.

Target users are maintainers of Claude plugin marketplaces or similar plugin registries who want reproducible, always-current documentation. Use cases include regenerating docs after any plugin add/update/remove, validating and previewing output before writing, and wiring doc generation into a plugin management workflow.

FAQ

Which files does it generate?

Four Markdown docs: agents.md (agent reference), agent-skills.md (skill catalog), plugins.md (plugin directory by category), and usage.md (usage guide), all rendered from Jinja2 templates in assets/.

How does it run?

Via the bundled doc_generator.py, e.g. python doc_generator.py to build all files, --file agents for one, --dry-run to preview without writing, and flags to set custom marketplace, templates, and output paths.

What is the data source?

It reads marketplace.json, validates its structure, scans plugin agent/command frontmatter and skill metadata, and computes stats, then feeds all of that into the templates.

What if a file or template is missing?

The script reports specific errors and suggestions, such as marketplace file not found, template not found, invalid plugin structure warnings, and frontmatter parse warnings.

Who should use it?

Maintainers of plugin marketplaces who want documentation regenerated automatically after every plugin add, update, or removal so docs match the catalog state.

All Files

6 files
assets/agents.md.j21.3 KB
View
SKILL.md9.7 KB
View
assets/plugins.md.j22.0 KB
View
assets/usage.md.j25.5 KB
View
assets/agent-skills.md.j21.9 KB
View
doc_generator.py16.6 KB
View

Install documentation-update

Download and extract the skill files to your .claude/skills/ directory.

Quick Setup:

  1. Copy the skill folder to .claude/skills/
  2. Claude will automatically detect and use the skill