Generating Documentation

Overview

The Generate page uses AI to create professional documentation from your codebase. Choose from API references, user-facing guides, or internal documentation—all generated automatically from your repository.

Generation Process

Step 1: Select Documentation Type

Choose the documentation type that matches your needs:

• API Reference — Complete endpoint documentation with schemas, authentication, and examples
• External Docs — User-facing guides, tutorials, and feature documentation
• Internal Docs — Technical architecture and implementation documentation for your team

Step 2: Configure Repository

Connect your GitHub repository to provide context:

• Select your repository from connected accounts
• Choose a specific branch (optional)
• Specify endpoint URL (required for API documentation)

Step 3: Generate Content

The generation interface provides three integrated workspaces:

Document Management (left sidebar) — Create, organize, and track multiple documents with automatic save status indicators.

Content Editor (center) — Toggle between Preview and Edit modes. During generation, view the AI's analysis process in real-time.

Generation Controls (right sidebar) — Add context files, write prompts, and initiate generation.