CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

source-command-generate-api-docs

Create comprehensive API documentation from source code

Quality

68%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.agents/skills/source-command-generate-api-docs/SKILL.md
SKILL.md
Quality
Evals
Security

source-command-generate-api-docs

Use this skill when the user asks to run the migrated source command generate-api-docs.

Command Template

API Documentation Generator

Generate API documentation by:

  1. Scanning all files in /src/api/
  2. Extracting function signatures and JSDoc comments
  3. Organizing by endpoint/module
  4. Creating markdown with examples
  5. Including request/response schemas
  6. Adding error documentation

Output format:

  • Markdown file in /docs/api.md
  • Include curl examples for all endpoints
  • Add TypeScript types
Repository

tonykay/transcriber

Path

.agents/skills/source-command-generate-api-docs/SKILL.md

Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.