Skip to main content

API Docs

Skill Verified Active
Part of:Ruflo Docs

Generate API documentation from source code with JSDoc and OpenAPI support

Purpose

To automate the generation and maintenance of API documentation, ensuring consistency and completeness for developers using JSDoc and OpenAPI standards.

Features

  • Generate API documentation from source code
  • Support for JSDoc annotations (@param, @returns, @throws, @example)
  • Automatic generation of missing JSDoc comments
  • Generate OpenAPI 3.0 specifications for HTTP endpoints

Use Cases

  • Automatically document new API endpoints or functions
  • Ensure all public APIs have JSDoc comments with types and descriptions
  • Maintain a consistent OpenAPI specification alongside source code
  • Generate documentation for codebases written in TypeScript and JavaScript

Non-Goals

  • Generating documentation for languages other than TypeScript/JavaScript
  • Creating UI documentation or user guides
  • Performing runtime analysis of API behavior

Workflow

  1. Scan source code for public exports
  2. Extract JSDoc annotations
  3. Generate missing JSDoc comments
  4. Generate OpenAPI 3.0 specification for HTTP endpoints

Practices

  • Documentation Generation
  • API Specification

Prerequisites

  • Node.js environment
  • Source code with JSDoc comments (recommended)

Installation

First, add the marketplace

/plugin marketplace add ruvnet/ruflo
/plugin install ruflo-docs@ruflo

Quality Score

Verified
99 /100
Analyzed about 20 hours ago

Trust Signals

Last commitabout 22 hours ago
Stars50.2k
LicenseMIT
Status
View Source

Similar Extensions

Deepinit

100

Deep codebase initialization with hierarchical AGENTS.md documentation

Skill
Yeachan-Heo

Cleanup Cycles

100

Detect and untangle circular dependencies. Runs madge/skott (TS), pycycle (Py), or compiler-only checks (Go/Rust). Auto-fixes leaf-extractable cycles; reports core cycles for human review. Use when the user asks to find circular imports, fix dependency cycles, or untangle module graph. Example queries — "find circular imports", "fix dependency cycles", "untangle our module graph", "why is madge complaining".

Skill
raintree-technology

Netlify Identity

100

Use when the task involves authentication, user signups, logins, password recovery, OAuth providers, role-based access control, or protecting routes and functions. Always use `@netlify/identity`. Never use `netlify-identity-widget` or `gotrue-js` — they are deprecated.

Skill
netlify

Vue Router Best Practices

100

Vue Router 4 patterns, navigation guards, route params, and route-component lifecycle interactions.

Skill
hyf0

Sentry React Router Framework Sdk

100

Full Sentry SDK setup for React Router Framework mode. Use when asked to "add Sentry to React Router Framework", "install @sentry/react-router", or configure error monitoring, tracing, profiling, session replay, logs, or user feedback for a React Router v7 framework app.

Skill
getsentry

Code Documenter

99

Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.

Skill
jeffallan

© 2025 SkillRepo · Find the right skill, skip the noise.