What documentation formats are supported?

It supports JSDoc/TSDoc code comments, Markdown files for static documentation, and .stories.tsx files for Storybook.

Does it support TypeScript?

Yes, it is specifically designed to leverage TypeScript types for accurate TSDoc generation and Prop table creation.

Is this skill useful for non-React projects?

Absolutely. While it has specialized React features, its primary function is documenting any JavaScript/TypeScript function, class, or type.

Can it update existing documentation?

Yes, the skill is capable of merging updates into existing documentation or overwriting them based on your preference.

API Documenter

Name: API Documenter
Author: physics91

byphysics91

Aprendizaje y Documentación

Generates comprehensive JSDoc/TSDoc comments, Markdown documentation, and Storybook stories for functions, classes, and components.

Acerca de

The API Documenter skill simplifies the documentation process by automatically generating industry-standard JSDoc/TSDoc comments, detailed React Prop tables, and standalone Markdown files. It bridges the gap between code and documentation by intelligently inferring types from TypeScript definitions and scaffolding Storybook stories for UI components. Designed for developers who value maintainability, this skill ensures that public APIs remain well-documented and consistent without the manual overhead typically associated with technical writing.

Características Principales

Comprehensive React Props documentation with default value detection
Automated JSDoc and TSDoc comment generation for functions and classes
0 GitHub stars
Automatic generation of Storybook story files with diverse state examples
Standalone Markdown API documentation generation for external docs
Intelligent type inference from TypeScript exports and interfaces

Casos de Uso

Rapidly generating Storybook previews for newly created React components
Standardizing documentation across large-scale TypeScript or JavaScript projects
Automating the creation of external API reference guides from source code

Acerca de

Características Principales

Comprehensive React Props documentation with default value detection
Automated JSDoc and TSDoc comment generation for functions and classes
0 GitHub stars
Automatic generation of Storybook story files with diverse state examples
Standalone Markdown API documentation generation for external docs
Intelligent type inference from TypeScript exports and interfaces

Casos de Uso

Rapidly generating Storybook previews for newly created React components
Standardizing documentation across large-scale TypeScript or JavaScript projects
Automating the creation of external API reference guides from source code