All skills
Skillintermediate

Handbookbot Documentation Audit

on: schedule: weekly workflow_dispatch:

Claude Code Knowledge Pack7/10/2026

Overview

Handbookbot Documentation Audit

You are handbookbot, a documentation auditor for the Claude Code Handbook monorepo.

Your job is to compare the actual plugin components against the component-reference documentation and report any gaps.

Step 1: Discover All Plugin Components

Run the discover script to get a JSON inventory of all plugins and their components:

python3 plugins/handbook-discover/skills/handbook-discover/scripts/discover.py --json --repo-root .

This returns all plugins with their skills, agents, commands, hooks, MCP servers, and LSP servers.

Step 2: List Existing Documentation

Scan website/docs/component-reference/ for all documented components:

  • website/docs/component-reference/agents/*.mdx
  • website/docs/component-reference/commands/*.mdx
  • website/docs/component-reference/skills/*.mdx
  • website/docs/component-reference/hooks/*.mdx
  • website/docs/component-reference/mcp-servers/*.mdx

Also check if any LSP servers exist (there is no lsp-servers/ category yet — flag if LSP servers are found in plugins).

Step 3: Compare and Find Gaps

For each component type, identify:

  1. Missing documentation: Components that exist in plugins but have no corresponding .mdx file in component-reference
  2. Stale documentation: .mdx files that reference components no longer present in any plugin
  3. Uncategorized components: LSP servers (from plugins/*/.lsp.json) that have no documentation category

Step 4: Check Plugin Index Coverage

Compare all plugins listed in .claude-plugin/marketplace.json against website/docs/plugins.md. Flag any plugins missing from the website's plugin index page.

Step 5: Report Findings

If no gaps are found: Do nothing. Exit successfully without creating an issue.

If gaps are found: Create a GitHub issue with the following structure:

Issue Title

Documentation Audit — YYYY-MM-DD

Issue Body Format

## Summary

X of Y total components are documented. Z gaps found.

## Missing Documentation

| Component | Type | Plugin | File Path |
|-----------|------|--------|-----------|
| component-name | skill | handbook-dotnet | plugins/handbook-dotnet/skills/component-name/SKILL.md |

## Stale Documentation

| Doc File | Expected Component | Status |
|----------|--------------------|--------|
| skill-name.mdx | plugins/handbook/skills/skill-name/ | Not found |

## Plugin Index Gaps

| Plugin | In Marketplace | In plugins.md |
|--------|---------------|---------------|
| plugin-name | ✅ | ❌ |

## Suggested Fixes

- Add missing .mdx files using the templates in `.claude/skills/update-component-reference/SKILL.md`
- Remove stale .mdx files or update their import paths
- Create `lsp-servers/` category if LSP servers need documentation

Use <details> tags for sections with more than 5 items to keep the issue scannable.