doc-validator

Scan repositories for Markdown files outside designated directories.

Updated Sep 11, 2024
One-click install
npx skills add https://github.com/Reading-Advantage-Thailand/www-reading-advantage --skill doc-validator-reading-advantage-thailand
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-validator
Source: https://github.com/Reading-Advantage-Thailand/www-reading-advantage/tree/main/.claude-old/skills/doc-validator
Command: npx skills add https://github.com/Reading-Advantage-Thailand/www-reading-advantage --skill doc-validator-reading-advantage-thailand

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 predefined, standard directories, ensuring a clean and organized repository structure.

Core Features & Use Cases

  • Markdown File Scanning: Scans the entire repository for .md files.
  • Location Validation: Checks if found .md files reside in allowed directories (e.g., docs/, skills/*/, root).
  • Warning Output: Reports any .md files found in non-standard locations.
  • Use Case: Before merging a new feature branch, 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 check for misplaced markdown files in my repository?

To check for misplaced markdown files, scan your repository to validate that all .md files reside only within designated directories like docs/, skills/*/, or the root level, and output warnings for any non-compliant placements found.

What is documentation sprawl and how do I prevent it?

Documentation sprawl is the uncontrolled spread of files across non-standard repository paths. Prevent it by validating markdown file locations and enforcing organizational standards that restrict .md files to designated directories such as docs/ or root.

How do I enforce repository structure standards for markdown documentation?

Enforce repository structure standards by scanning for .md files outside of allowed directories like docs/ and skills/*/, then outputting warnings for non-compliant file placements to ensure a clean and organized repository structure.

Can I validate markdown file locations before merging a feature branch?

Yes, you can validate markdown file locations before merging a feature branch by running a validation script that scans the entire repository and flags any new documentation files placed outside of the correct docs/ or skills/ subdirectories.

What directories are considered valid locations for markdown files in a repository?

Valid locations for markdown files in a repository include designated directories such as docs/, skills/*/, and root-level documentation files. Files found outside these predefined paths are flagged as non-compliant.

Why does my repository have markdown files in the wrong directories?

Markdown files appear in wrong directories due to documentation sprawl, where organizational standards are not enforced. Scanning for .md files outside of designated directories like docs/ identifies these misplaced files and outputs warnings for correction.