auto-doc-gen

Generate and synchronize Markdown API documentation from code comments.

2|Updated May 10, 2026
One-click install
npx skills add https://github.com/freedomw1987/tree_monstor --skill auto-doc-gen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: auto-doc-gen
Source: https://github.com/freedomw1987/tree_monstor/tree/main/skills/auto-doc-gen
Command: npx skills add https://github.com/freedomw1987/tree_monstor --skill auto-doc-gen

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about auto-doc-gen

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

FAQPage Schema
How do I automatically generate API documentation from JSDoc and Python docstrings?

You can automatically generate API documentation from JSDoc and Python docstrings by parsing code comments to produce Markdown files. This process extracts annotations directly from your source code to eliminate manual updates.

How do I sync REST API docs with code changes without overwriting manual edits?

To sync REST API docs with code changes without losing manual edits, use incremental update support. This feature compares generated content with existing files and only updates changed sections to prevent documentation drift.

Does auto-generated API documentation work with Go and TypeScript projects?

Auto-generated API documentation works with Go, TypeScript, JavaScript, and Python projects. It parses godoc comments and TSDoc annotations to extract endpoint definitions and outputs formatted Markdown documentation.

How do I validate endpoint count consistency to ensure documentation accuracy?

You validate endpoint count consistency by comparing the number of parsed code endpoints against the generated Markdown documentation. This mechanism ensures documentation accuracy by catching missing or extra API definitions.

What is the best way to eliminate manual API documentation updates for development teams?

The best way to eliminate manual API documentation updates is automating synchronization from code comments. This approach extracts TSDoc, JSDoc, Python docstrings, and Go godoc annotations directly into Markdown files.