documentation-verification

Validate documentation completeness, broken links, and code example accuracy.

7|2|Updated Feb 20, 2026

Search Tags:#quality assurance #documentation #verification #code examples #link checking #pre-merge review

Ready to run

npx skills add https://github.com/PracticalSwan/agent-skills --skill documentation-verification

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-verification
Source: https://github.com/PracticalSwan/agent-skills/tree/main/documentation-verification
Command: npx skills add https://github.com/PracticalSwan/agent-skills --skill documentation-verification

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires markdown-link-check, lychee, linkchecker, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the risk of merging documentation that is incomplete, contains broken links, has inaccurate code examples, or is factually incorrect, ensuring a higher quality of published content.

Core Features & Use Cases

Link Validation: Automatically checks for broken internal and external links within Markdown files.
Code Snippet Accuracy: Verifies that code examples are still relevant and functional.
Completeness Check: Ensures that documentation changes align with user-facing behavior changes.
Use Case: Before merging a pull request that updates API documentation, use this skill to automatically verify that all code examples still compile and all internal links point to existing pages.

Quick Start

Run the documentation verification skill to check all markdown links in the current directory.

Frequently Asked Questions about documentation-verification

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

FAQPage Schema

How do I check for broken links in Markdown documentation before merging a pull request?▼

Automated link validation checks internal and external links within Markdown files to prevent broken URLs before merging a pull request. This process uses scripts like markdown-link-check or lychee to verify all paths resolve correctly.

What is the best way to verify code example accuracy in README files?▼

Verifying code example accuracy in README files involves running validation checks to ensure snippets still compile and remain functional. This pre-merge review confirms that documentation code examples align with current user-facing behavior.

Do I need to install markdown-link-check or lychee to validate documentation completeness?▼

Yes, you need link checking dependencies such as markdown-link-check, lychee, or linkchecker installed in your environment. These scripts provide the underlying functionality required to execute automated link validation procedures during your documentation review.

Can I use documentation verification for pre-merge review of setup guides and configuration files?▼

Yes, you can use documentation verification for pre-merge review of setup guides and configuration files. The process applies quality gates to READMEs and config files to ensure factual correctness, completeness, and accurate code examples before release.

What are the limitations of automated link checking for API documentation updates?▼

Automated link checking limitations include relying on predefined validation procedures and scripts, which may not catch factual inaccuracies or incomplete documentation updates if the validation rules are not comprehensively defined for the specific API changes.