repository-documentation-factory

Audit repositories and generate evidence-backed documentation for commands, APIs, configuration, and workflows.

10|1|Updated Jul 7, 2026
One-click install
npx skills add https://github.com/catalystctl/catcode --skill repository-documentation-factory-catalystctl
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repository-documentation-factory
Source: https://github.com/catalystctl/catcode/tree/main/.catalyst-code/skills/repository-documentation-factory
Command: npx skills add https://github.com/catalystctl/catcode --skill repository-documentation-factory-catalystctl

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Software repositories often lack complete, accurate documentation, and manually documenting every command, config key, API, and plugin is slow and error-prone. This Skill audits a codebase and produces verified documentation grounded in actual source evidence rather than assumptions. ## Core Features & Use Cases - Evidence-Backed Inventories: Builds canonical inventories of CLI commands, configuration keys, environment variables, APIs, plugins, tools, and errors, each traced to source code or verified execution. - Parallel Documentation Workflow: Coordinates concurrent discovery and drafting workers with non-overlapping file ownership to document large repositories without duplication or conflicts. - Quality Gates and Gap Sweeps: Scores documentation against a 100-point rubric, re-runs discovery after drafting, and refuses to declare completion below a 95-point threshold. - Use Case: Point it at a fast-moving CLI tool repository whose docs have drifted from the code; it inventories every public command and config key, repairs stale pages, verifies examples by running them, and delivers a coverage report. ## Quick Start Audit this repository and create complete, verified documentation for all commands, configuration, APIs, and features.

Frequently Asked Questions about repository-documentation-factory

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for an entire code repository?

Invoke the skill with a request like "document the repository" and it builds a repository map, inventories every public command, config key, API, and plugin from source evidence, then drafts and verifies documentation. It supports Rust, TypeScript, Go, and Python discovery patterns.

How does it prevent hallucinated or inaccurate documentation?

Every documented claim must trace to executable code, schemas, registries, tests, or verified command execution recorded in an internal evidence ledger. Claims with low confidence cannot appear in stable user-facing docs without an explicit caveat.

Can it document only a specific part of a repository?

Yes, focused mode handles requests naming a specific surface such as CLI commands, API, plugins, configuration, architecture, or troubleshooting. It still inspects adjacent surfaces needed to keep the focused documentation accurate.

Does it work with monorepos and multiple programming languages?

Yes, it inspects workspace manifests, build files, and package structures, and includes discovery patterns for Rust, TypeScript/JavaScript, Go, and Python. Worker domains partition by evidence domain rather than arbitrary directories.

What are the limitations of automated repository documentation?

It cannot verify examples when execution is unsafe or impossible, so those are validated against parsers or marked illustrative. It also avoids documenting dead, test-only, or unreachable behavior, and reports unresolved gaps honestly in the final report.