doc-validator

Name: doc-validator
Availability: InStock
Author: bodangren

Scan repositories for Markdown files outside standard directories and output warnings.

11|3|Updated Oct 21, 2025

Search Tags:#code quality #documentation #markdown #validation #repository structure

Ready to run

npx skills add https://github.com/bodangren/git-workflow --skill doc-validator-bodangren

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-validator
Source: https://github.com/bodangren/git-workflow/tree/main/.claude/skills/doc-validator
Command: npx skills add https://github.com/bodangren/git-workflow --skill doc-validator-bodangren

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This skill prevents documentation sprawl by identifying and flagging Markdown files located outside of standard project directories, ensuring a clean and organized repository.

Core Features & Use Cases

Markdown File Scanning: Scans the entire repository for .md files.
Location Validation: Checks files against a predefined list of allowed directories and patterns.
Warning Output: Reports any .md files found in non-standard locations.
Use Case: Before merging a new feature, run this skill to ensure all new documentation files are placed in the correct docs/ or skills/ subdirectories, preventing clutter.

Quick Start

Run the doc validator script to check for misplaced markdown files.

Frequently Asked Questions about doc-validator

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

FAQPage Schema

How do I prevent documentation sprawl in a project repository?▼

Preventing documentation sprawl involves scanning the repository for Markdown files outside standard directories like docs/ and skills/, then outputting warnings for non-compliant files to enforce organizational standards.

How do I validate the location of Markdown files in my repository?▼

You validate Markdown file locations by scanning the repository for .md files and checking them against a predefined list of allowed directories and patterns to report non-compliant files.

Why are my Markdown files being flagged during the code quality check?▼

Your Markdown files are flagged because they are located outside predefined standard directories such as docs/, skills/, or root-level documentation, violating organizational standards.

What is the best way to enforce documentation standards before merging a feature?▼

The best way to enforce documentation standards before merging is running a validation script that scans for misplaced .md files and outputs warnings for any files found in non-standard locations.

Can I check my repository structure for non-standard Markdown file placement?▼

Yes, you can check repository structure by scanning for .md files outside predefined standard directories like docs/ and skills/, ensuring all new documentation files are placed correctly to prevent clutter.