Can it detect broken links in documentation?

Yes, it specifically checks for valid internal paths, absolute cross-package links, and external URLs in both MDX content and property configuration files.

Does it support different framework terminologies?

Absolutely. It validates that the correct terms are used based on the framework, such as 'Composables' for Vue, 'Runes' for Svelte, or 'Hooks' for Preact and Qwik.

How does this skill ensure documentation accuracy?

The skill performs a step-by-step comparison between the actual TypeScript source code and the documentation files, checking function signatures, generics, and parameter types for an exact match.

What documentation formats does this skill audit?

It is optimized for auditing MDX files (index.mdx), TypeScript property definitions (properties.ts), and Markdown navigation files (menu.md).

API Documentation Reviewer

Name: API Documentation Reviewer
Author: open-circle

byopen-circle

•

619

•

内容管理

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.

主要功能

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

使用场景

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

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add open-circle/formisch repo-website-api-review

For use in Claude.ai and ChatGPT

Download Skill