check-docs-links

Name: check-docs-links
Availability: InStock
Author: GDSDN

Validate internal markdown links in the docs directory for broken links and status mismatches.

3|Updated Feb 7, 2026

Search Tags:#documentation #markdown #validation #links #scripting #ci

Ready to run

npx skills add https://github.com/GDSDN/kord-aios --skill check-docs-links

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: check-docs-links
Source: https://github.com/GDSDN/kord-aios/tree/main/src/features/builtin-skills/kord-aios/documentation/check-docs-links
Command: npx skills add https://github.com/GDSDN/kord-aios --skill check-docs-links

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill ensures the integrity of internal links within your documentation, preventing broken links and identifying content that is planned but not yet available.

Core Features & Use Cases

Broken Link Detection: Identifies links pointing to non-existent files.
Status Mismatch: Flags links marked as "coming soon" that actually point to existing files.
Planned Content Identification: Lists links marked for future content.
Use Case: Before deploying new documentation, run this skill to catch any typos or incorrect paths that would lead users to dead ends, ensuring a smooth and reliable documentation experience.

Quick Start

Run the check-markdown-links.py script to validate all internal links in the docs directory.

Frequently Asked Questions about check-docs-links

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

FAQPage Schema

How do I validate internal markdown links in my documentation directory?▼

To validate internal markdown links, run the Python script to check all paths in the 'docs/' directory. It identifies broken links, detects incorrect 'coming soon' markers, and lists planned content to prevent dead ends.

What is the best way to detect broken markdown links before deploying documentation?▼

Detecting broken markdown links is done by running a Python script that checks internal paths. It flags non-existent files and status mismatches, ensuring a reliable documentation experience before deployment.

Can I integrate markdown link validation into my CI pipeline?▼

Yes, you can integrate markdown link validation into your CI pipeline. The Python script performs deterministic link checking and reporting, supporting CI integration to automatically catch incorrect paths during builds.

How do I identify planned content and 'coming soon' markers in markdown files?▼

Identifying planned content and 'coming soon' markers is handled by the validation script. It lists links marked for future content and flags status mismatches where 'coming soon' markers incorrectly point to existing files.

Does the documentation link checker support auto-correction for broken links?▼

Yes, the documentation link checker supports auto-correction features. Alongside detecting broken links and planned content, the script provides functionalities to automatically fix incorrect paths within the 'docs/' directory.

Why does my markdown link validation report show a status mismatch error?▼

A status mismatch error appears during markdown link validation when links marked as 'coming soon' actually point to existing files. The script flags these mismatches to ensure documentation status markers remain accurate.