docs-validate

Scan Claude codebases to validate SKILL.md frontmatter, symlinks, and README structure.

Updated Mar 21, 2026
One-click install
npx skills add https://github.com/tatsushige-i/shared-claude-code --skill docs-validate
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-validate
Source: https://github.com/tatsushige-i/shared-claude-code/tree/main/docs/ja-JP/local-skills/local-docs-validate
Command: npx skills add https://github.com/tatsushige-i/shared-claude-code --skill docs-validate

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Shared Claude code repository documentation often becomes inconsistent across skills, rules, and translations; this skill validates that SKILL frontmatter exists and matches, symlinks are correct, and README structures stay coherent, proposing fixes when possible.

Core Features & Use Cases

  • Validate the presence and consistency of SKILL.md frontmatter (name and description) in each skill.
  • Verify that symlinks under .claude/skills correctly point to ../../skills/<name> and flag broken links.
  • Check that skills appear in skills/README.md and that Japanese translations exist under docs/ja-JP/skills/<name>/SKILL.md.
  • Use case: maintain a healthy, navigable skills catalog across multilingual repos.

Quick Start

Scan the repo to identify a collated report of inconsistencies and suggested fixes.

Frequently Asked Questions about docs-validate

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

FAQPage Schema
How do I validate SKILL.md frontmatter consistency in a monorepo?

You can validate SKILL.md frontmatter by scanning the repository for required name and description fields. This reports missing or inconsistent frontmatter across skills, ensuring documentation integrity throughout the shared codebase.

How do I check for broken symlinks under .claude/skills?

Checking for broken symlinks involves verifying that paths under .claude/skills correctly point to ../../skills/<name>. This validates symlink integrity and flags any incorrect or broken links for repair.

What is the best way to maintain multilingual README structures across translations?

Maintaining multilingual README structures requires checking that skills appear in skills/README.md and that Japanese translations exist under docs/ja-JP/skills/<name>/SKILL.md. This ensures coherent, navigable documentation across languages.

Can I automate documentation validation across shared Claude codebases?

You can automate documentation validation by running a repository scan that collates inconsistencies in frontmatter, symlinks, and README structures. This generates a report with suggested fixes for maintaining a healthy skills catalog.

Why does my skills catalog show documentation discrepancies across translations?

Documentation discrepancies occur when SKILL.md frontmatter is missing, symlinks point incorrectly, or translations under docs/ja-JP/skills/<name>/SKILL.md are absent. Scanning identifies these specific gaps and proposes fixes.