docs-lint

Automate documentation review for broken links and MkDocs compliance.

32|7|Updated Jun 18, 2025

Search Tags:#quality assurance #linting #documentation #technical writing #style guide #MkDocs #link checker

One-click install

npx skills add https://github.com/kazunori279/adk-streaming-guide --skill docs-lint

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: docs-lint
Source: https://github.com/kazunori279/adk-streaming-guide/tree/main/.claude/skills/docs-lint
Command: npx skills add https://github.com/kazunori279/adk-streaming-guide --skill docs-lint

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires curl, and includes scripts (resource) components.

What problem does it solve?

Manual documentation review is time-consuming and prone to missing inconsistencies in style, formatting, and broken links. This Skill automates the review process, ensuring high-quality, consistent documentation with minimal effort.

Core Features & Use Cases

Automated Link Checking: Automatically identifies and reports dead external links (404, 403, timeout errors), saving hours of manual verification.
Style & Formatting Enforcement: Checks for consistent structure, writing style, formatting, and MkDocs compliance (e.g., admonition indentation, code block language tags).
Code Quality Review: Ensures code examples are correct, properly formatted, and adhere to repository style guidelines.
Use Case: Before publishing a new set of technical documents, use this Skill to automatically scan all files for broken links, inconsistent formatting, and incorrect code examples, then apply critical fixes to ensure a seamless reading experience.

Quick Start

Review the attached 'new_feature.md' document for critical and warning level issues, focusing on MkDocs compliance and external links.