docs-lint

Automate link validation by running checks against all external links in your documentation files to catch 404 errors and timeouts. This ensures external link validity and prevents broken references before merging documentation pages.

Prevent code drift by validating that code snippets referenced in documentation still exist in their original locations within linked repositories. This source reference checking automatically detects and can auto-fix drift against sibling repositories.

Enforce a documentation style guide by checking structural consistency, style, and formatting across all documentation parts. This includes specific validation for MkDocs compliance to ensure adherence to platform-specific requirements.

Yes, you need Python3 and git installed to run documentation linting checks. These dependencies are required to execute the validation scripts, check source code references, and interact with linked repositories for drift detection.

The best way to validate documentation content before merging is to run automated checks for broken external links, verify source code references are up-to-date, and ensure style guide compliance. This prevents user confusion and maintains professional standards.