Will this skill move or delete my files automatically?

No, the skill is non-destructive. It only reports warnings for misplaced files, allowing you to decide whether to move, delete, or whitelist them.

Can I customize which directories are allowed?

Yes, you can easily extend the allowed patterns by adding new directory paths to the ALLOWED_PATTERNS array within the underlying validator script.

What does the Markdown Doc Validator skill do?

It scans your repository for Markdown (.md) files located outside of approved directories like /docs or skill-specific folders to prevent documentation sprawl.

Is this skill compatible with CI/CD?

Absolutely. It generates parsable warnings and is designed to be integrated into automated quality checks and continuous integration pipelines.

Markdown Doc Validator

Name: Markdown Doc Validator
Author: bodangren

bybodangren

•

Content Management

Validates Markdown file placement within a repository to prevent documentation sprawl and enforce structural standards.

The Markdown Doc Validator is a specialized utility designed to maintain repository hygiene by ensuring all documentation follows a standardized directory structure. It automatically scans for .md files located in non-standard directories, providing actionable warnings to help developers organize project knowledge into approved locations like the docs/ folder or specific skill directories. By integrating this validator into existing workflows or CI/CD pipelines, teams can eliminate documentation sprawl, improve information discoverability, and maintain a clean, professional codebase consistent with AgenticDev conventions.

Key Features

01Actionable warnings for misplaced or abandoned documentation files

029 GitHub stars

03Automated Markdown scanning across the entire repository

04Customizable whitelist for project-specific documentation exceptions

05Predefined allowed patterns for root, docs, and skill-specific directories

06Seamless integration with CI/CD pipelines and quality check workflows

Use Cases

01Auditing legacy repositories to consolidate scattered notes into standardized locations

02Ensuring documentation compliance during code reviews or before merging pull requests

03Enforcing organizational standards within automated agentic development workflows

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add bodangren/git-workflow doc-validator

For use in Claude.ai and ChatGPT

Download Skill