doc-smith-check

Official

Validate Doc-Smith docs: structure and content.

AuthorAIGNE-io
Version1.0.0
Installs0

System Documentation

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

Dependency Matrix

Required Modules

yaml

Components

scripts

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-smith-check
Download link: https://github.com/AIGNE-io/doc-smith-skills/archive/main.zip#doc-smith-check

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.