API Documentation Reviewer
Ensures technical documentation accuracy by systematically verifying API routes against source code and project standards.
The repo-website-api-review skill provides a rigorous framework for auditing and maintaining high-quality documentation for the Formisch library. It facilitates the comparison of source code function signatures, types, and JSDoc annotations against MDX documentation files to prevent technical drift. By automating checks for framework-specific terminology, cross-package link integrity, and TypeScript generic constraints, this skill helps maintain a single source of truth between the codebase and the developer-facing website.
Características Principales
01Source-to-doc signature and type comparison
02Consistency checking for properties.ts and index.mdx files
03Front matter and menu organization verification
04Automated link validation for cross-package and external resources
05Framework-specific terminology auditing (Composables, Runes, Hooks)
06619 GitHub stars
Casos de Uso
01Validating internal linking and navigation structure for documentation websites
02Auditing documentation accuracy after library refactors or API changes
03Ensuring style guide compliance for new API documentation contributions