check-docs

To validate README.md and CLAUDE.md documentation, run a check that verifies file existence, content validity, and link integrity, ensuring install steps and cross-references remain current. The tool outputs a clear pass/fail result.

Documentation cross-reference validation ensures that links between Markdown files are accurate and navigable. It is needed to reduce onboarding time and prevent misinformation caused by outdated or broken paths in project directories.

Yes, you can apply documentation validation checks to project submodules to ensure install steps, links, and cross-references remain current across all referenced directories and Markdown files.

Identify documentation gaps by scanning for missing or empty Markdown files, verifying that CLAUDE.md presence and path references are correct, and checking that linked commands are current in the project.

The best way to keep project docs up-to-date is to enforce regular checks through file existence, content validity, and link integrity, providing a clear pass/fail output for quick fixes and maintenance.