🤖 AI Documentation Generator

Automatically generate comprehensive documentation for any GitHub repository using AI. Just provide a repository URL and let AI create detailed docs for your codebase.

Repository Configuration
Configure your GitHub repository and AI settings to generate documentation

Required to push documentation to any repository.

Token Scope Requirements:

repoRequired for private repositories (full control)
public_repoSufficient for public repositories
workflowOptional - Update GitHub workflows

💡 Recommendation:

Use repo scope for all repositories to avoid permission issues.

AI Configuration

Smart Documentation Features

Incremental Updates

The system automatically detects existing documentation branches and only processes changed or new files, making subsequent runs much faster.

✓ Existing Branch Detection⚡ Changed Files Only🔄 Auto Merge from Main

First run: Documents all files • Subsequent runs: Only updates changed files

💡 Temporary files are automatically cleaned after successful completion

Advanced Options

Regenerate all documentation files instead of incremental updates

Proceed without confirmation prompts

GitHub Token Setup Guide
Follow these steps to create a GitHub Personal Access Token with the correct permissions

Quick Setup:

  1. Click the "Generate token" link above
  2. Sign in to GitHub if prompted
  3. Verify the required scopes are selected
  4. Set expiration (90 days recommended)
  5. Click "Generate token"
  6. Copy the token and paste it above

Manual Setup:

  1. Go to GitHub Settings → Developer settings
  2. Click "Personal access tokens" → "Tokens (classic)"
  3. Click "Generate new token" → "Generate new token (classic)"
  4. Add description: "AI Docs Generator"
  5. Select scopes based on your needs:
    repoFor private repositories (includes public_repo)
    public_repoFor public repositories only
  6. Click "Generate token" and copy it immediately

Important: Copy your token immediately as it won't be shown again. Store it securely and never share it publicly.

Supported File Types
The following programming languages and file types are supported for documentation generation
JavaScript (.js, .jsx)TypeScript (.ts, .tsx)Python (.py)Java (.java)C/C++ (.c, .cpp, .cc)Go (.go)Rust (.rs)PHP (.php)Ruby (.rb)C# (.cs)Swift (.swift)Kotlin (.kt)Scala (.scala)Vue (.vue)Svelte (.svelte)And more...