doc-qa

Validate Markdown documentation for formatting, broken links, and code block language identifiers.

Updated Apr 9, 2026
One-click install
npx skills add https://github.com/nist0/CoDev --skill doc-qa
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-qa
Source: https://github.com/nist0/CoDev/tree/main/.github/skills/doc-qa
Command: npx skills add https://github.com/nist0/CoDev --skill doc-qa

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires markdownlint-cli2, link-checker.py, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of linting and validating Markdown documentation, checking for broken links, heading hierarchy, code block fences, and providing a fix list.

Core Features & Use Cases

  • Markdown Linting: Checks for common Markdown formatting issues like trailing spaces, heading levels, and code block language identifiers.
  • Broken Link Checking: Validates internal and external links within the documentation.
  • Heading Hierarchy Verification: Ensures proper heading structure for better navigation.
  • Code Block Language Identification: Ensures all code blocks have the correct language identifiers for syntax highlighting.
  • Fix List Production: Generates a list of issues with actionable fixes for each file.
  • CI Integration: Can be integrated into CI pipelines for ongoing documentation quality checks.

Quick Start

Run the doc-qa skill on your Markdown documentation with the command: python scripts/validate-markdown-lint.py

Frequently Asked Questions about doc-qa

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

FAQPage Schema
How do I check Markdown documentation for broken links and formatting issues?

To check Markdown documentation for broken links and formatting issues, you can use an automated validation process that scans files for heading hierarchy errors, missing code block language identifiers, and invalid internal or external links.

Can I integrate Markdown linting into a CI/CD pipeline for ongoing quality checks?

Yes, you can integrate Markdown linting into a CI/CD pipeline for ongoing quality assurance. The validation process runs automated checks on documentation files to ensure consistent formatting and valid links during continuous integration.

Do I need markdownlint-cli2 to validate Markdown files?

Yes, you need markdownlint-cli2 to validate Markdown files. This dependency is required along with link-checker.py to perform comprehensive formatting checks and verify that internal and external links are not broken.

What is the best way to fix missing code block language identifiers in Markdown?

The best way to fix missing code block language identifiers in Markdown is to run a validation script that detects the issue and generates an actionable fix list, detailing exactly which code blocks require language tags for syntax highlighting.

Why does my Markdown heading hierarchy fail validation?

Your Markdown heading hierarchy fails validation because it contains skipped heading levels or improper nesting. The linter checks for proper heading structure to ensure better navigation and flags these structural inconsistencies for correction.