docs-generate

Generate project documentation from JSDoc/TSDoc, API routes, and component props.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/gpaura/claude_plugins --skill docs-generate
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-generate
Source: https://github.com/gpaura/claude_plugins/tree/main/skills/docs-generate
Command: npx skills add https://github.com/gpaura/claude_plugins --skill docs-generate

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps developers produce consistent, high-quality documentation for codebases by generating code docs, API references, and component guides, reducing manual effort and onboarding time.

Core Features & Use Cases

  • Code Documentation: Extract and format JSDoc/TSDoc comments into organized docs for functions, classes, and modules.
  • API Documentation: Generate endpoint descriptions, request/response formats, authentication requirements, and error mappings.
  • Component Documentation: Document props, usage examples, accessibility notes, and visual examples.
  • README Templates: Create project-wide README sections including setup, environment variables, and deployment notes.
  • Use Cases: Onboarding new developers, migrating legacy docs, or maintaining up-to-date docs across microservices.

Quick Start

Run the docs-generate command on your repository to produce a complete documentation suite (code, API, component docs, and README templates).

Frequently Asked Questions about docs-generate

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation from JSDoc and TSDoc comments?

To generate API documentation from JSDoc and TSDoc comments, this Skill extracts inline annotations and formats them into organized endpoint descriptions, request/response formats, and authentication requirements. It leverages TypeDoc to parse comments into comprehensive API references automatically.

What is the best way to create component documentation with props and usage examples?

Creating component documentation with props and usage examples is handled by extracting component metadata and integrating optional Storybook visual examples. This Skill compiles props, accessibility notes, and usage guides into structured component docs for frontend libraries.

Can I use this to generate a README for an existing repository?

Yes, you can use this to generate a README for an existing repository. It creates project-wide README templates that include setup instructions, environment variables, and deployment notes by analyzing your codebase structure and extracting configuration details.

Does this documentation generator work for large codebases and microservices?

This documentation generator works for large codebases and microservices by extracting API route details and module structures at scale. It supports team workflows and maintains consistent documentation across multiple services without manual effort.

Do I need Storybook to generate component docs?

You do not need Storybook to generate component docs, as it is an optional integration. The Skill extracts props, types, and usage examples natively, but adding Storybook enables visual examples and accessibility notes within the generated component documentation.