doc-gen

Generate OpenAPI specs and Markdown API references from codebases.

3|Updated Jul 4, 2020
One-click install
npx skills add https://github.com/mei28/dotfiles --skill doc-gen-mei28
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-gen
Source: https://github.com/mei28/dotfiles/tree/main/.claude/skills/doc-gen
Command: npx skills add https://github.com/mei28/dotfiles --skill doc-gen-mei28

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API documentation often lags behind code, causing confusion and slow onboarding.

Core Features & Use Cases

  • OpenAPI/Swagger spec generation from code
  • JSDoc/TSDoc comments extraction and Markdown API references
  • Markdown API reference and usage examples for quick consumption

Quick Start

Run the doc-gen CLI on your codebase to generate and update API documentation.

Frequently Asked Questions about doc-gen

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

FAQPage Schema
How do I generate OpenAPI specs from code automatically?

To generate OpenAPI specs from code automatically, you can run the doc-gen CLI on your codebase. It extracts OpenAPI specs, JSDoc/TSDoc comments, and API references from REST and GraphQL endpoints to produce a complete specification file.

Can I extract JSDoc and TSDoc comments into a Markdown API reference?

Yes, you can extract JSDoc and TSDoc comments into a Markdown API reference. The tool processes your TypeScript or JavaScript projects to pull comments and generate a formatted Markdown reference guide with usage examples for quick consumption.

Does this API documentation generator work with Python and Java projects?

This API documentation generator works with Python and Java projects, alongside TypeScript and JavaScript. It extracts API definitions from REST and GraphQL endpoints across these languages to generate OpenAPI specs and Markdown references.

What's the best way to keep API documentation consistent with my codebase?

The best way to keep API documentation consistent with your codebase is to automate generation directly from code using validation tooling. This approach extracts OpenAPI specs and JSDoc comments to ensure your documentation matches your current implementation.

How do I generate code examples for my GraphQL and REST API reference?

You can generate code examples for your GraphQL and REST API reference by running the doc-gen CLI. It processes your codebase to produce a complete Markdown API reference that includes generated code examples and optional documentation annotations.