Features

AI-powered documentation generator that analyzes GitHub repositories and automatically creates beautiful, hosted documentation websites.

Target Audience: Software teams and individual developers who want production-ready documentation without manual writing — from startups documenting open-source projects to enterprises documenting microservices architectures. Works across all programming languages and project types.

Core

Interactive Documentation Setup

One command to set up comprehensive documentation with GitHub OAuth authentication, repository selection, API key configuration, and full analysis pipeline in an interactive guided flow.

<details> <summary>Related files</summary>

• packages/cli/src/commands/init.ts
• packages/cli/src/auth/device-flow.ts
• packages/cli/src/github/repo-picker.ts

</details>

AI-Powered Architecture Analysis

Claude AI agents automatically analyze and document project architecture, including tech stack identification, module breakdown, data flow diagrams, entry points, key patterns, and Mermaid architecture diagrams.

<details> <summary>Related files</summary>

• packages/analyzer/src/agents/architect.ts
• packages/analyzer/src/pipeline.ts
• packages/analyzer/src/agent-sdk.ts

</details>

REST API Documentation Generation

Automatically extracts and documents all REST API endpoints with HTTP methods, URL paths, parameters (path/query/header/body), request/response bodies, authentication requirements, and relationship diagrams.

<details> <summary>Related files</summary>

• packages/analyzer/src/agents/api-doc.ts
• packages/analyzer/src/types.ts

</details>

UI Component Documentation

Discovers and documents UI components across frameworks with component names, descriptions, prop definitions (type, required status, defaults), usage examples, and categories.

<details> <summary>Related files</summary>

• packages/analyzer/src/agents/component-doc.ts
• packages/analyzer/src/types.ts

</details>

Data Model & Schema Documentation

Extracts and documents data models with field definitions, types, constraints, relationships, and generates Entity-Relationship (ER) diagrams using Mermaid syntax.

<details> <summary>Related files</summary>

• packages/analyzer/src/agents/model-doc.ts
• packages/analyzer/src/types.ts

</details>

User-Facing Features Analysis

AI synthesizes a product-oriented overview identifying key capabilities, features categorized by type, and real-world use cases from the technical architecture and code.

<details> <summary>Related files</summary>

• packages/analyzer/src/agents/features.ts
• packages/analyzer/src/types.ts

</details>

Multi-Repository Analysis & Cross-Service Documentation

Documents multiple repositories together, analyzing shared dependencies, identifying API contracts between services, mapping service relationships, and generating cross-repo integration diagrams.

<details> <summary>Related files</summary>

• packages/analyzer/src/agents/cross-repo.ts
• packages/cli/src/commands/init.ts

</details>

Language-Agnostic Code Analysis

Works with TypeScript, JavaScript, Python, Go, Rust, Java, Kotlin, Ruby, PHP, C#, Swift and more, using AI-powered understanding rather than language-specific parsers.

<details> <summary>Related files</summary>

• packages/analyzer/src/parsers/tree.ts
• packages/analyzer/src/agents/architect.ts

</details>

Developer Experience

AI-Generated Getting Started Guides

Automatically creates step-by-step getting started guides with prerequisites, installation instructions, quick start examples, configuration options, and code examples extracted from actual project files.

<details> <summary>Related files</summary>

• packages/analyzer/src/agents/guide-writer.ts
• packages/analyzer/src/types.ts

</details>

Fumadocs-Based Documentation Site Generation

Scaffolds a fully functional Next.js documentation website using Fumadocs with built-in full-text search, dark mode toggle, responsive sidebar navigation, and production-ready deployment configuration.

<details> <summary>Related files</summary>

• packages/generator/src/scaffold.ts
• packages/site-template/
• packages/generator/src/content-writer.ts

</details>

Project Context Via CLAUDE.md

Reads optional CLAUDE.md files to inject insider knowledge into AI prompts, improving documentation accuracy through developer-provided context about conventions, architecture patterns, and project conventions.

<details> <summary>Related files</summary>

• packages/analyzer/src/parsers/claude-md.ts
• packages/analyzer/src/agents/architect.ts

</details>

Integration

Vercel Deployment Integration

Creates a GitHub repository for documentation and pushes content for seamless Vercel auto-deployment, with automatic redeployment on documentation updates.

<details> <summary>Related files</summary>

• packages/cli/src/commands/deploy.ts
• packages/cli/src/github/fetcher.ts

</details>

GitHub Actions CI/CD Automation

Adds a GitHub Actions workflow to source repositories that automatically re-analyzes code and updates documentation on every push to main, enabling zero-maintenance documentation sync.

<details> <summary>Related files</summary>

• packages/cli/src/commands/setup-ci.ts

</details>

Performance

Incremental Analysis & Caching

Re-analyzes only changed files since last run using commit SHA tracking and diff analysis, significantly reducing API costs and regeneration time for large repositories.

<details> <summary>Related files</summary>

• packages/analyzer/src/diff.ts
• packages/analyzer/src/pipeline.ts
• packages/cli/src/commands/generate.ts

</details>

Security

Secure Credential Management

Securely stores GitHub OAuth tokens and Anthropic API keys with restrictive file permissions (0600), provides login/logout commands for credential lifecycle management.

<details> <summary>Related files</summary>

• packages/cli/src/auth/token-store.ts
• packages/cli/src/commands/login.ts
• packages/cli/src/commands/logout.ts

</details>

Use Cases

Document a New GitHub Repository

Run one command to authenticate with GitHub, select a repository, and generate a complete documentation site with architecture overview, API docs, component library, and getting started guide. Preview locally and deploy to Vercel in minutes.

Involves: Interactive Documentation Setup, AI-Powered Architecture Analysis, REST API Documentation Generation, AI-Generated Getting Started Guides, Fumadocs-Based Documentation Site Generation, Vercel Deployment Integration

Document a Microservices Architecture

Select multiple repositories representing different services. The tool analyzes them together to identify shared dependencies, map API contracts between services, show data flow across microservices, and generate relationship diagrams.

Involves: Multi-Repository Analysis & Cross-Service Documentation, REST API Documentation Generation, AI-Powered Architecture Analysis, Fumadocs-Based Documentation Site Generation

Auto-Update Documentation on Every Code Push

Run setup-ci to add a GitHub Actions workflow to your source repository. Whenever code is pushed to main, the action automatically re-analyzes changed files and updates the documentation site on Vercel with zero manual effort.

Involves: GitHub Actions CI/CD Automation, Incremental Analysis & Caching, Vercel Deployment Integration, Secure Credential Management

Document a Component Library with Props

Run the generator on a UI component library (React, Vue, Svelte, or any framework). The tool discovers all components, extracts props with types and defaults, generates usage examples, organizes them by category, and displays them in an interactive documentation site.

Involves: UI Component Documentation, AI-Generated Getting Started Guides, Fumadocs-Based Documentation Site Generation, Language-Agnostic Code Analysis

Maintain Consistent Documentation Across Large Codebases

After initial setup, run open-auto-doc generate --incremental periodically or on CI/CD. The tool only re-analyzes files that changed, reducing API costs while keeping documentation synchronized with code evolution.

Involves: Incremental Analysis & Caching, AI-Powered Architecture Analysis, GitHub Actions CI/CD Automation, Project Context Via CLAUDE.md