doc-sync

SKILL.md

This skill ensures documentation stays synchronized with code changes. It provides validation tools, pre-push checks, and integration with RFC-37 documentation standards.

| README presence | Verifies README.md exists | Error | | Broken links | Checks internal markdown links | Warning | | API docs | Looks for generated API documentation | Info | | Freshness | Compares doc timestamps to code | Warning | | RFC-37 structure | Validates docs/ folder structure | Error |

The system can verify documentation is updated when significant files change:

Validates documentation is synchronized with code changes. Integrates with RFC-37 doclinter for structure validation and pre-push hooks to enforce documentation updates. Use after making significant code changes or when documentation gaps exist. Source: bitsoex/bitso-java.

View raw