doc-check

Name: doc-check
Availability: InStock
Author: t-hasuike

Detect broken links, naming violations, and README inconsistencies in knowledge and reports directories.

Updated Mar 11, 2026

Search Tags:#documentation #diagnose #knowledge-management #naming-convention #dead-links #promotion-readiness #readme-consistency

Ready to run

npx skills add https://github.com/t-hasuike/CLysis --skill doc-check-t-hasuike

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-check
Source: https://github.com/t-hasuike/CLysis/tree/main/legacy-knowledge/skills/doc-check
Command: npx skills add https://github.com/t-hasuike/CLysis --skill doc-check-t-hasuike

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Diagnoses document integrity by detecting dead links, naming convention violations, and README mismatches to flag promotion readiness.

Core Features & Use Cases

Dead-link detection across knowledge/markdown files to ensure references remain valid.
Naming convention checks to enforce consistent file naming for knowledge assets.
README consistency verification to align directory structure with the documentation.
Promotion readiness assessment for reports to guide sequencing of doc-organization.

Quick Start

Run the diagnosis after finishing documentation work to verify integrity and determine promotion readiness.

Frequently Asked Questions about doc-check

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

FAQPage Schema

How do I check markdown files for dead links before publishing?▼

You can verify document integrity by running a diagnosis that detects dead links, naming convention violations, and README inconsistencies within knowledge/ and reports/ directories.

What is document promotion readiness assessment for knowledge assets?▼

Document promotion readiness assessment is the process of evaluating files under knowledge/ and reports/ directories to ensure they have valid links, consistent naming, and aligned README structures before advancing them.

How do I enforce naming conventions across my knowledge management directory?▼

To enforce naming conventions across your knowledge management directory, run the integrity check to detect naming violations and ensure consistent file naming for all knowledge assets.

Do I need a valid SKILL.md frontmatter to run document integrity checks?▼

Yes, you need a valid SKILL.md frontmatter containing a name and description, along with a working scripts/check-dead-links.sh utility, to execute the document integrity and readiness checks.

Why are my README files inconsistent with my directory structure?▼

Your README files are inconsistent because directory structures have drifted from documentation; running a README consistency verification aligns the directory structure with the actual documentation files.