skill-readme-linter

To lint markdown documentation for missing sections, run the linter on your skill directory. It checks SKILL.md and README.md files to enforce documentation completeness, returning a structured JSON payload of issues and suggested fixes.

You can check README formatting and required sections by running a documentation linter. It validates word count, code blocks, and section presence, returning a structured JSON payload with ok and data fields detailing formatting issues.

Markdown documentation validation is the process of enforcing completeness and formatting standards in docs. You need it during skill activation to reduce misdocumentation and ensure required sections, quick-start guidance, and examples are present.

Yes, you can validate quick-start examples and code blocks in markdown files. The linter checks for example presence and code block formatting to demonstrate behavior, ensuring ease of use and returning a structured report of any issues found.

Yes, the documentation linter returns a structured JSON payload containing ok and data fields for downstream tooling. It accepts an input skill_path and outputs a detailed report of documentation issues, enabling automated quality validation pipelines.

Automated markdown validation focuses on structural completeness, formatting, and example presence in SKILL.md and README.md. It does not assess technical accuracy or semantic correctness of the documented content, only whether required sections and formatting standards are met.