docs-lint

What problem does it solve?

This Skill addresses the challenge of maintaining high-quality, consistent documentation by automating the review of external links, source code references, and adherence to style guidelines.

Core Features & Use Cases

• Link Validation: Automatically checks all external links within documentation files for validity (e.g., 404 errors, timeouts).
• Source Reference Checking: Validates that code snippets referenced in documentation still exist in their original locations in linked repositories, auto-fixing drift.
• Style and Formatting Compliance: Ensures adherence to documentation style guides and platform-specific requirements (e.g., MkDocs compliance).
• Use Case: Before merging a new set of documentation pages, run this Skill to catch broken links and ensure all code examples are up-to-date and correctly referenced, preventing user confusion and maintaining a professional standard.

Quick Start

Run the docs-lint skill to check all external links and source code references in the documentation.