Skip to content

AI Documentation

Auto-generate documentation for files, modules, and entire projects. Mermaid architecture diagrams, changelogs from git history, and JSDoc/TSDoc comments.

📝

File Docs

`/docs <file>` for any source file.

📂

Module Docs

`/docs <module>` for entire modules.

🎨

Mermaid Diagrams

`/mermaid` generates architecture diagrams.

📋

Changelog

`/changelog` from git history.

📊

Session Reports

`/report` with token and cost analytics.

🤖

Doc-Writer Agent

Dedicated agent for comprehensive docs.

What Gets Documented

From individual functions to entire project architectures — the AI writes documentation at every level of abstraction.

📝

Functions & Methods

JSDoc / TSDoc / docstrings for every exported function — parameters, return types, and example usage.

📂

Modules & Files

Module-level README.md files explaining the purpose, exports, and how to use each module.

🏗️

Project Architecture

High-level architecture guide: data flow, service interactions, key design decisions.

🖼️

Diagrams

Mermaid diagrams for database schema, auth flows, API routes, and service dependencies.

Mermaid Diagrams

Generate visual diagrams directly from your codebase. The AI analyzes the structure and relationships, then outputs Mermaid syntax you can embed in any Markdown document.

/mermaidProject architecture overview (boxes and arrows)
/mermaid database schemaER diagram from your database models
/mermaid auth flowSequence diagram for authentication
/mermaid api routesFlowchart of all API endpoints

# Example Mermaid Output

graph TD
  A[Client] --> B[API Gateway]
  B --> C[Auth Service]
  B --> D[User Service]
  C --> E[(Database)]
  D --> E

Changelog Generation

Run /changelog to generate a CHANGELOG.md entry in Keep-a-Changelog format from your git history since the last tag. The AI groups commits by type (Added, Changed, Fixed, Security) and writes human-readable release notes.

CHANGELOG.md
## [1.3.0] - 2025-07-21

### Added
- AI-powered security scanning with SARIF output
- GitHub Security Tab integration

### Changed
- Improved false-positive detection in code review

### Fixed
- Auth token refresh on session expiry

Automate documentation

Let the AI write and maintain your docs while you focus on building.

Get started