compound-docs

Generate categorized markdown documentation with YAML frontmatter for solved problems.

24.1k|2.0k|Updated Oct 9, 2025
One-click install
npx skills add https://github.com/EveryInc/compound-engineering-plugin --skill compound-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/EveryInc/compound-engineering-plugin/tree/main/plugins/compound-engineering/skills/compound-docs
Command: npx skills add https://github.com/EveryInc/compound-engineering-plugin --skill compound-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

Automatically document solved problems into categorized documentation with YAML frontmatter to enable fast lookup and knowledge sharing.

Core Features & Use Cases

  • Auto-capture after confirmation
  • Categorize by problem type and environment
  • Use YAML frontmatter for searchability
  • Build a reusable knowledge base for future sessions

Quick Start

Confirm that a problem is solved, then generate and store a documentation entry.

Frequently Asked Questions about compound-docs

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

FAQPage Schema
How do I automatically document solved problems with YAML frontmatter?

Compound-docs captures solved problems as markdown files with YAML frontmatter after you confirm resolution. It categorizes documentation into directories, sanitizes filenames, and validates metadata against a schema for fast lookup and knowledge reuse across sessions.

What categories can I use to organize my documented solutions?

Categories are enum-constrained in compound-docs to ensure consistent problem classification. The Skill generates one markdown file per solved issue under category directories (docs/solutions/[category]), enabling standardized organization across your knowledge base.

Can I use compound-docs to build a searchable knowledge base from past issues?

Yes. Compound-docs automatically stores solved problems as categorized markdown files with YAML frontmatter metadata, creating a deterministic, searchable knowledge base. Future sessions can retrieve solutions quickly by category and problem type.

How does the YAML frontmatter improve searchability of documented solutions?

YAML frontmatter in compound-docs stores structured metadata validated against a defined schema, enabling fast lookup by problem attributes. Frontmatter fields are extracted from Step 2 context and templated into each markdown file for efficient filtering and retrieval.

What happens to filenames when I document a solved problem?

Compound-docs sanitizes filenames automatically to ensure deterministic file creation and safe filesystem compatibility. Original problem details are preserved in YAML frontmatter and markdown content while filenames remain clean and consistent.

Does compound-docs work across multiple problem types and environments?

Yes. Compound-docs categorizes solutions by problem type and environment through enum-constrained categorization, storing each solved issue as a separate markdown file. This supports diverse problem domains and contexts within a unified knowledge base.

Related Skills