docs.validate.skilldocs

Validate SKILL.md documentation against skill.yaml manifests for drift.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires PyYAML.

What problem does it solve?

Ensures SKILL.md docs reflect their skill.yaml manifests, including required headers and manifest parity.

Core Features & Use Cases

  • Validates required headers in SKILL.md
  • Validates manifest parity between SKILL.md and skill.yaml
  • Reports warnings for minor issues and errors for critical problems

Quick Start

python skills/docs.validate.skill_docs/skill_docs_validate.py skills/api.validate

Frequently Asked Questions about docs.validate.skilldocs

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

FAQPage Schema
How do I validate that my SKILL.md documentation matches my skill.yaml manifest?

Documentation validation checks that SKILL.md reflects your skill.yaml manifest, detecting drift in required headers and field parity. Run the validator against your skill directory to report errors, warnings, and parity status between files.

What does SKILL.md validation check for in Betty Framework skills?

Validation checks required headers in SKILL.md, ensures inputs and outputs match between documentation and manifest, verifies cross-file consistency across use cases and integrations, and flags critical problems as errors or minor issues as warnings.

Can I use this validator with my existing Betty Framework skill structure?

Yes, the validator applies to Betty Framework skills. It loads your skill.yaml and SKILL.md files, parses and compares their fields, and reports validation results. Run it directly on your skill directory using the provided command.

What happens if my SKILL.md headers don't match the skill.yaml manifest?

The validator reports misaligned headers and field inconsistencies between files as errors or warnings depending on severity. This drift detection ensures documentation stays synchronized with manifest definitions.

How do I know if my documentation has parity issues with the manifest?

The validator reports parity status explicitly when comparing SKILL.md and skill.yaml fields. Errors flag critical mismatches; warnings flag minor inconsistencies in required sections or field definitions.