What sections are included in the generated documentation?

The generator creates a comprehensive file including an Overview, Purpose, Usage examples, Parameter tables, Output descriptions, and Integration notes.

Will it overwrite my existing documentation automatically?

No, it includes safety checks. You must explicitly use the --overwrite=true flag to replace an existing SKILL.md file.

How does this skill prevent documentation drift?

It treats the skill.yaml manifest as the single source of truth and automatically regenerates the SKILL.md file, ensuring the documentation always reflects the actual code parameters.

Can I preview the documentation before saving it?

Yes, by using the --dry-run flag, the skill will output the formatted Markdown content to your console without creating or modifying any files.

Is it possible to automate this in a CI/CD pipeline?

Absolutely. You can include a step in your workflow to run the generator and compare the output, failing the build if the documentation is out of sync with the manifest.

Betty Skill Documentation Generator

Name: Betty Skill Documentation Generator
Author: epieczko

byepieczko

0•

学习与文档

Automatically generates and maintains standardized SKILL.md documentation from skill.yaml manifests to prevent documentation drift.

The generate.docs skill automates the creation of comprehensive documentation for the Betty framework by extracting metadata, parameters, and outputs directly from authoritative YAML manifests. By transforming structured data into standardized Markdown, it ensures that project documentation remains consistent, accurate, and synchronized with the source code without manual intervention. This skill is an essential utility for developers and teams who want to maintain high-quality documentation standards through safe overwrites, dry-run previews, and seamless CI/CD integration.

主要功能

01Dry-run mode for previewing documentation without writing to disk

02Generates standardized sections for parameters, outputs, and usage templates

03Easy integration with Git hooks and automated CI/CD pipelines

040 GitHub stars

05Automatic manifest-to-markdown conversion using YAML sources

06Support for custom output paths and safe file overwrite protection

使用场景

01Syncing skill documentation with manifest changes during active development

02Standardizing documentation format across a large repository of specialized skills

03Automating documentation verification in build pipelines to prevent outdated content

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add epieczko/betty generate.docs

For use in Claude.ai and ChatGPT

Download Skill