generate.docs

Generate and update SKILL.md documentation from skill.yaml manifests.

2|Updated Oct 22, 2025
One-click install
npx skills add https://github.com/epieczko/betty --skill generate-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate.docs
Source: https://github.com/epieczko/betty/tree/main/skills/generate.docs
Command: npx skills add https://github.com/epieczko/betty --skill generate-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires yaml.

What problem does it solve?

Automatically generates or updates SKILL.md documentation from skill.yaml manifests to ensure documentation stays in sync with implementation.

Core Features & Use Cases

  • Parse skill.yaml and extract inputs, outputs, and metadata
  • Create standardized SKILL.md content with sections: Overview, Usage, Parameters, Outputs
  • Support dry-run previews and safe overwrites
  • Batch-generation across multiple skills

Quick Start

python skills/generate.docs/generate_docs.py skills/api.define/skill.yaml

Frequently Asked Questions about generate.docs

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

FAQPage Schema
How do I automatically generate documentation from skill.yaml files?

Documentation generation reads your skill.yaml manifest, extracts inputs, outputs, and metadata, then creates standardized SKILL.md files with Overview, Purpose, Usage, Parameters, Outputs, and Integration Notes sections. Run the generator pointing to your skill.yaml to produce consistent docs that stay synchronized with your implementation.

Can I preview documentation changes before applying them?

Yes, dry-run mode lets you preview generated SKILL.md content without overwriting existing files. This is especially useful in CI/CD pipelines and local editing workflows where you want to verify formatting and content accuracy before committing changes.

What's the best way to keep documentation in sync with skill implementations?

Automate documentation generation as part of your development workflow by parsing skill.yaml manifests directly. This approach eliminates manual doc updates and ensures Parameters, Outputs, and Integration Notes always reflect your current implementation without redundant editing.

Does this work for batch documentation generation across multiple skills?

Yes, the generator supports batch-generation workflows, enabling you to update documentation across multiple Betty skills simultaneously. This scales documentation maintenance across large skill repositories and development environments.

What input format do I need to use for documentation generation?

Documentation generation requires skill.yaml manifest files containing skill metadata, inputs, and outputs definitions. The YAML format is parsed to extract all necessary information for standardized doc creation.

Can I integrate documentation generation into CI/CD pipelines?

Yes, the dry-run preview and safe-overwrite features are designed for CI/CD integration. You can validate doc changes before merge, automate generation on skill updates, and safely deploy updated SKILL.md files without manual intervention.