API Docs

Generate API documentation from source code with JSDoc and OpenAPI support

thedixitjain 113cbc3 968 B Updated 2 repo stars

File contents

Generate API documentation from TypeScript/JavaScript source:

  1. Scan exports: Find all public functions, classes, and interfaces
  2. Extract JSDoc: Parse @param, @returns, @throws, @example annotations
  3. Generate missing docs: Add JSDoc for undocumented public APIs
  4. OpenAPI spec: For HTTP endpoints, generate OpenAPI 3.0 definitions

Dispatch via MCP: mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch({ trigger: "document", scope: "api" })

Conventions:

  • Every public export must have a JSDoc comment
  • Include @param with type and description
  • Include @returns with type and description
  • Include @throws for known error conditions
  • Include @example for non-obvious usage

Source: ruvnet/rufloplugins/ruflo-docs/skills/api-docs/SKILL.md

thedixitjain/the-mega-skill-library/tree/main/library/docs-and-knowledge-mgmt/api-docs commit 113cbc3e9b

Frequently asked questions

npx skillmds add thedixitjain/api-docs