doc-lint

Validate markdown syntax, links, and JSON structures in documentation repositories.

18|Updated Apr 5, 2026
One-click install
npx skills add https://github.com/walm00/business-context-os --skill doc-lint-walm00
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-lint
Source: https://github.com/walm00/business-context-os/tree/main/.claude/skills/doc-lint
Command: npx skills add https://github.com/walm00/business-context-os --skill doc-lint-walm00

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

It streamlines the process of maintaining high-quality documentation by automatically checking markdown syntax, cross-references, and JSON structures, reducing manual review time.

Core Features & Use Cases

  • Markdown validation: Detects syntax errors, broken links, and formatting issues in Markdown files.
  • Cross-reference validation: Checks link integrity between documents and verifies section anchors.
  • JSON structure validation: Ensures JSON files are well-formed, with no duplicate keys or syntax errors.
  • Use Case: Facilitates continuous documentation quality assurance in technical projects, ensuring all links and structures are error-free before publishing.

Quick Start

Run the doc-lint skill on your documentation folder to identify and resolve formatting and structural issues.

Frequently Asked Questions about doc-lint

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

FAQPage Schema
How do I check for broken links and syntax errors in markdown documentation?

To check for broken links and syntax errors in markdown documentation, you can automate validation to detect formatting issues, verify cross-reference integrity, and ensure section anchors are correctly linked before publishing.

Does JSON validation catch duplicate keys and structural errors in documentation files?

JSON validation does catch duplicate keys and structural errors in documentation files by ensuring JSON structures are well-formed, preventing syntax errors from reaching published documents.

How do I automate continuous documentation quality assurance for technical projects?

You can automate continuous documentation quality assurance by running automated checks on markdown syntax, cross-references, and JSON structures within your repository, ensuring all links and structures are error-free before publishing.

What is the best way to verify cross-reference integrity between markdown files?

The best way to verify cross-reference integrity between markdown files is to use automated validation that checks link integrity between documents and verifies section anchors to prevent broken navigation.

Can I use automated documentation validation without installing external dependencies?

You can run automated documentation validation without external dependencies because the tool operates using internal scripts and references to check markdown and JSON files directly within your repository.

Why does markdown validation fail on broken section anchors in cross-references?

Markdown validation fails on broken section anchors in cross-references because the automated checker verifies link integrity between documents and detects when section anchors do not match the target headings.