Clean Docs¶

Documentation quality CLI - Validate code snippets, detect broken links, auto-fix issues, and integrate with CI/CD.

Quick Start¶

Installation¶

# Via pip (recommended)
pip install clean-docs                       # Core features
pip install 'clean-docs[snippets]'           # + Code snippet validation
pip install 'clean-docs[snippets,semantic]'  # All features

# Or via curl installer
curl -fsSL https://raw.githubusercontent.com/Algiras/clean-docs/main/install.sh | bash

Basic Usage¶

# Check your setup
clean-docs doctor

# Scan for broken links
clean-docs scan ./docs

# Validate code snippets
clean-docs validate-snippets ./docs --code-dir ./src

# Auto-fix issues
clean-docs scan ./docs --fix --yes

Why Clean Docs?¶

Documentation quality degrades over time. Code changes but examples don't get updated. Links break. Clean Docs helps you:

• Catch outdated code examples before users do
• Find broken links across your entire documentation
• Automate fixes to reduce manual work
• Integrate with CI to prevent regressions

Supported Languages¶

For code snippet validation, clean-docs supports:

License¶

MIT License - see LICENSE.