What problem does it solve?
Hand-written documentation in JS packages drifts out of sync with source code as exports, function signatures, types, and enums evolve, causing coding agents that read these docs from node_modules to write broken code.
Core Features & Use Cases
- Export Completeness Checks: Compares barrel file exports (src/index.ts) against the documented export list to find missing or stale entries.
- Signature and Type Verification: Validates documented function signatures, generics, union types, interfaces, and enum values against actual TypeScript source.
- Example Validation: Checks that code examples reference real exports, use correct parameter shapes, and contain valid TypeScript syntax.
- Use Case: After modifying the public API of a package under js/packages/, run this Skill to re-verify only the affected doc files, fix discrepancies, and update the Source Code Map in docs/README.md.
Quick Start
Ask the AI to sync the docs for the JS package you just modified so the documentation matches the current source code.