What problem does it solve?
Doc-Smith projects often suffer from inconsistent documentation structures and undetected content issues, which hinder reliability and maintenance. This skill provides automated validation to ensure both the structure and content meet defined standards.
Core Features & Use Cases
- Structure validation: checks planning/document-structure.yaml for syntax, required fields (title, path, description), path formatting, and sourcePaths correctness.
- Content validation: verifies document files exist, .meta.yaml metadata presence, internal links validity, and image paths accuracy.
- Reuse in workflows: can be invoked by other doc-smith skills to perform pre-publish or pre-translation validation.
Quick Start
Run the all checks with /doc-smith-check to validate structure and content.
- Check structure only: /doc-smith-check --structure
- Check content only: /doc-smith-check --content
- Check specific docs: /doc-smith-check --content --path /overview --path /guides/start