auto-doc-gen

Community

Auto-sync API docs from code comments, no manual work.

Authorfreedomw1987
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Manually updating API documentation to match code changes is time-consuming and prone to errors, often leading to outdated docs that mislead development teams and external users.

Core Features & Use Cases

  • Multi-language annotation parsing: Extracts documentation from JSDoc/TSDoc (TypeScript/JavaScript), Python docstrings, and Go godoc comments to generate Markdown API docs.
  • Incremental update support: Compares generated content with existing documentation files and only updates changed sections to preserve manual edits.
  • Use Case: Development teams maintaining REST API services can use this skill to automatically sync docs after endpoint modifications, eliminating documentation drift.

Quick Start

Use the auto-doc-gen skill to generate updated API documentation for the TypeScript endpoints in the ./src/api directory and save it to docs/api.md.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: auto-doc-gen
Download link: https://github.com/freedomw1987/tree_monstor/archive/main.zip#auto-doc-gen

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 536,000+ vetted skills library on demand.