doc-smith-check

Validate Doc-Smith document structure, content, and link integrity.

9|Updated Dec 22, 2025
One-click install
npx skills add https://github.com/AIGNE-io/doc-smith-skills --skill doc-smith-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-smith-check
Source: https://github.com/AIGNE-io/doc-smith-skills/tree/main/skills/doc-smith-check
Command: npx skills add https://github.com/AIGNE-io/doc-smith-skills --skill doc-smith-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires yaml, and includes scripts (resource) components.

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

Frequently Asked Questions about doc-smith-check

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

FAQPage Schema
How do I validate documentation structure and YAML frontmatter in a docs project?

You can validate documentation structure and YAML frontmatter by running automated checks to confirm document-structure.yaml correctness, verify required fields, and enforce metadata presence across all files.

What is the best way to check for broken internal links and missing image paths in documentation?

Checking for broken internal links and missing image paths involves scanning document files to verify that all references point to existing resources and that image paths are accurate across languages.

Can I run a content validation check on specific documentation paths only?

Yes, you can run content validation on specific documentation paths by passing the desired path arguments during invocation, allowing you to target specific sections like guides or overviews instead of the entire project.

Does this validation tool check YAML syntax and required fields in document-structure.yaml?

Yes, the validation tool checks YAML syntax and validates required fields such as title, path, and description, while also confirming path formatting and sourcePaths correctness within the document-structure.yaml file.

When do I need pre-publish validation for documentation projects?

Pre-publish validation for documentation projects is needed before releasing or translating content to ensure structural integrity, confirm .meta.yaml metadata presence, and prevent broken links or missing images from reaching users.

Can other documentation skills invoke this validation process automatically?

Yes, other doc-smith skills can invoke this validation process automatically, enabling seamless integration into larger workflows for pre-publish or pre-translation checks without manual intervention.