api-docs-generator

$npx mdskill add vercel-labs/cooking-school-feedback/api-docs-generator

Generate structured API documentation from route files.

  • Converts TypeScript types into markdown for endpoints.
  • Scans project directories for route definitions.
  • Extracts methods, parameters, and response schemas.
  • Outputs formatted docs to a new markdown file.

SKILL.md

.github/skills/api-docs-generatorView on GitHub ↗
---
name: api-docs-generator
description: Generates agent-friendly markdown documentation for API routes. Use when user says "generate docs", "document this API", "create API documentation", or "make docs for my endpoints".
---

# API Docs Generator

TODO: Write the skill instructions here.

## Instructions

<!-- TODO: Add step-by-step instructions for how Claude should:
  1. Discover API route files in the project
  2. Analyze each route (methods, params, body, responses, errors)
  3. Read the TypeScript types
  4. Generate structured markdown docs
  5. Write the output file
-->

## Quality checklist

<!-- TODO: Add verification checks the skill should run before finishing -->