repo-website-api-review

Review API documentation routes against source code for accuracy.

1.1k|32|Updated Apr 5, 2025
One-click install
npx skills add https://github.com/open-circle/formisch --skill repo-website-api-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-website-api-review
Source: https://github.com/open-circle/formisch/tree/main/skills/repo-website-api-review
Command: npx skills add https://github.com/open-circle/formisch --skill repo-website-api-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps ensure API documentation on the Formisch website accurately reflects source code, preventing mismatches in function signatures, types, and usage examples.

Core Features & Use Cases

  • Systematic source-code comparison for each documented API
  • Validation of properties.ts and index.mdx for consistency
  • Cross-package link integrity and menu alignment

Quick Start

Run a documentation review pass on the website's API docs, verify a sample API against its source code, and report any mismatches or missing details.

Frequently Asked Questions about repo-website-api-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I verify API documentation matches source code signatures?

You can verify API documentation by running a review pass that compares documented routes against source code to enforce exact function signatures, generics, and parameters. The skill reports mismatches and missing details.

What does an API documentation audit check for consistency?

An API documentation audit checks properties.ts and index.mdx files for consistency, validating cross-package link integrity, href validity, and menu alignment to ensure documentation accurately reflects source code.

Can I use this to validate cross-package links and href validity in API docs?

Yes, you can validate cross-package link integrity and href validity during a documentation audit. The skill enforces link validity to meet source-of-truth requirements across the website.

When do I need to review API documentation routes against source code?

You need to review API documentation routes against source code when preventing mismatches in function signatures, types, and usage examples during documentation audits across the website.

Does this documentation review tool check generics and parameter types?

Yes, the documentation review tool enforces exact function signatures, generics, and parameters. It systematically compares documented APIs against source code to ensure accuracy and consistency.