release-docs_skill

This skill helps you generate up-to-date release documentation for the compound-engineering plugin by syncing agents, commands, skills, and servers.

Python

24

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill ratacat/claude-skills --skill release-docs

SKILL.md6.0 KB

Overview

This skill builds and updates the documentation site for the compound-engineering plugin, ensuring docs reflect the current plugin components. It inventories agents, commands, skills, and MCP servers, regenerates relevant HTML pages and metadata, validates outputs, and can run in a dry-run preview mode. The tool is designed for repeatable documentation releases tied to the plugin source tree.

How this skill works

The skill reads component files under plugins/compound-engineering (agents, commands, skills, mcp-servers), extracts frontmatter and metadata, and counts components. It regenerates specific static pages (index, agents, commands, skills, mcp-servers), updates plugin JSON/marketplace metadata and README content, then runs JSON and content validation. With --dry-run it reports proposed changes and diffs without writing files.

When to use it

After adding, removing, or modifying agents, commands, skills, or MCP servers
Before publishing a plugin release or marketplace update
When stats or component lists on the docs site are out of sync with source files
To validate metadata and JSON consistency across plugin files
When preparing a changelog entry for documentation updates

Best practices

Run the tool locally with --dry-run first to review diffs and catch frontmatter errors
Keep component frontmatter (name, description, category) consistent and complete to avoid skipped items
Commit source component changes before running to ensure accurate counts
Validate JSON output (jq) and fix errors before applying updates
Update CHANGELOG.md and use a descriptive commit message after successful regen

Example use cases

Full documentation release after finishing multiple agents: claude /release-docs
Preview documentation changes after editing a command: claude /release-docs --dry-run
Regenerate only pages to reflect new MCP server integrations and tools
Automated CI job that runs validation and fails if counts or JSON are inconsistent
Pre-release checklist step to ensure docs, plugin.json, marketplace.json and README are synchronized

FAQ

--dry-run performs the full inventory, validation, and generates diffs for proposed changes but does not write any files.

What happens if a component has invalid frontmatter?

The tool reports the frontmatter error and skips that component; it halts JSON validation failures and aborts updates to avoid partial writes.