✨ Crafting Professional Documentation with AI Precision

An open-source developer tool that automatically generates high-quality READMEs, CONTRIBUTING guides, and API documentation — so your code finally gets the docs it deserves.

About • Setup • Architecture • Structure • Tech Stack • Roadmap • Contributing • License

---

📖 About AutoDoc.ai

"Because great code deserves great documentation."

Every developer knows the feeling — you've just shipped an amazing project, but the documentation is either missing, outdated, or consists of three bullet points and a TODO comment. AutoDoc.ai was built to solve exactly this problem.

AutoDoc.ai is an intelligent, open-source documentation engine that deeply analyzes your repository structure and source code to generate comprehensive, structured, and production-ready documentation — automatically. It respects developer autonomy by keeping humans firmly in control through live previews and manual editing, while the AI handles the heavy lifting.

Whether you're preparing a project for an open-source hackathon, a job portfolio, or a collaborative team environment, AutoDoc.ai ensures your repository makes the best possible first impression.

🌟 Key Features

Feature	Description
🔍 Deep Repo Analysis	Scans repository structure, configuration files, and code patterns for comprehensive understanding
⚡ Instant Generation	Creates README.md, CONTRIBUTING.md, and API docs in seconds, not hours
🌐 API Documentation	Dedicated support for REST API endpoint documentation generation
👁️ Live Preview	React-based real-time markdown preview with inline manual editing
📤 Export Ready	One-click export producing clean, production-ready documentation files
🤖 AI-Powered Accuracy	Multi-provider AI support including OpenAI, Gemini, Anthropic, NVIDIA, and compatible providers
🧩 Modular Architecture	Three-layer design enabling easy extension and customization
🔓 100% Open Source	MIT Licensed — free for personal, academic, and commercial use

---

⚙️ Setup Instructions

Important

Ensure you have Node.js v18 or later installed before getting started.

1. Clone the Repository

git clone https://github.com/abhro05/AutoDoc.ai.git
cd AutoDoc.ai

2. Install Dependencies

npm install

3. Start the Development Server

npm run dev

The application will be available at:

http://localhost:3000

4. Build for Production

npm run build

5. Preview the Production Build

npm run preview

Tip

If you encounter dependency-related issues, delete node_modules and package-lock.json, then run npm install again.

---

🔄 System Architecture

AutoDoc.ai follows a full-stack architecture consisting of a React + Vite frontend, a Node.js + Express backend, Supabase-based authentication, and a configurable multi-provider AI integration layer.

The frontend provides the user interface and documentation workflow, while the backend handles authentication, repository analysis, provider orchestration, and documentation generation.

┌─────────────────────┐
│    User Browser     │
└──────────┬──────────┘
           │
           ▼
┌─────────────────────┐
│ React + Vite Client │
└──────────┬──────────┘
           │
           ▼
┌─────────────────────┐
│ Node.js + Express   │
│      Backend        │
└──────────┬──────────┘
           │
 ┌─────────┼──────────────┐
 ▼         ▼              ▼
Supabase  GitHub API   LLM Providers

                     ┌───────────┐
                     │ OpenAI    │
                     │ Gemini    │
                     │ Anthropic │
                     │ NVIDIA    │
                     └───────────┘

Application Flow

graph LR
    A[🏠 Home Page] --> B[⚡ Generator]
    B --> C[📄 Generated Output]
    A --> D[👥 Contributors]

    style A fill:#0A192F,stroke:#38BDF8,color:#fff
    style B fill:#064E3B,stroke:#34D399,color:#fff
    style C fill:#1E1B4B,stroke:#818CF8,color:#fff
    style D fill:#7C2D12,stroke:#FB923C,color:#fff

Loading

Architecture Overview

Layer	Technology	Responsibility
Frontend	React 18 + Vite	User interface, routing, and rendering
Backend	Node.js + Express	API endpoints, authentication, and documentation generation
Authentication	Supabase	Email/password login, OAuth, session management
AI Provider Layer	OpenAI, Gemini, Anthropic, NVIDIA, Custom Providers	Documentation generation and LLM orchestration
External Services	GitHub API	Repository analysis and contributor information
State Management	React Context API	Authentication and theme state
Styling	CSS3 + Theme System	Responsive UI and dark/light themes
Build System	Vite	Development server and production builds

Note

The architecture is designed to support multiple AI providers, scalable backend services, and future feature expansion while maintaining clear separation between frontend, backend, authentication, and provider integrations.

---

📁 Project Structure

AutoDoc.ai/
│
├── .github/
│   ├── ISSUE_TEMPLATE/
│   │   ├── ❄️-feature-request.md
│   │   ├── 🐛-bug-report.md
│   │   ├── 💬-general---blank-issue.md
│   │   └── 📝-documentation-update.md
│   │
│   ├── workflows/
│   │   └── issue-greeter.yml
│   │
│   └── pull_request_template.md
│
├── .husky/                             # Git hooks
│
├── api/                                # Express backend
│   ├── models/
│   │   └── User.js
│   │
│   ├── routes/
│   │   └── auth.js
│   │
│   ├── utils/
│   │   ├── authValidation.js
│   │   └── supabaseAdmin.js
│   │
│   ├── auth.test.js
│   ├── generate-readme.js              # Documentation generation logic
│   └── generate-readme.test.js
│
├── src/                                # React + Vite frontend
│   │
│   ├── components/
│   │   ├── Footer.jsx
│   │   ├── Footer.css
│   │   ├── Navbar.jsx
│   │   ├── Navbar.css
│   │   ├── ProtectedRoute.jsx
│   │   ├── ProtectedRoute.css
│   │   ├── Spinner.jsx
│   │   ├── Spinner.css
│   │   ├── ThemeToggle.jsx
│   │   └── ThemeToggle.css
│   │
│   ├── context/
│   │   ├── AuthContext.jsx
│   │   └── ThemeContext.jsx
│   │
│   ├── pages/
│   │   ├── Home.jsx
│   │   ├── Generator.jsx
│   │   ├── Contributors.jsx
│   │   ├── Login.jsx
│   │   ├── Signup.jsx
│   │   ├── ForgotPassword.jsx
│   │   ├── ResetPassword.jsx
│   │   ├── AuthSuccess.jsx
│   │   └── NotFound.jsx
│   │
│   ├── styles/
│   │   ├── Home.css
│   │   ├── Generator.css
│   │   ├── Contributors.css
│   │   ├── Login.css
│   │   ├── Signup.css
│   │   ├── NotFound.css
│   │   └── theme.css
│   │
│   ├── supabase/
│   │   └── client.js
│   │
│   ├── utils/
│   │   ├── authErrors.js
│   │   ├── authErrors.test.js
│   │   ├── performanceOptimization.js
│   │   └── routePreloader.js
│   │
│   ├── App.jsx
│   └── main.jsx
│
├── .env.example                        # Environment template
├── .gitignore
├── autodoc.png
├── CODE_OF_CONDUCT.md
├── commitlint.config.js
├── CONTRIBUTING.md
├── index.html
├── LICENSE
├── package.json
├── package-lock.json
├── README.md
├── THEME_SYSTEM.md
├── vite.config.js
└── server.js                           # Express server entry point

---

🛠️ Tech Stack

AutoDoc.ai is built with a modular, scalable architecture across three specialized layers.

🌐 Frontend Layer

React: A React-based web interface for repository input and real-time previews. Languages: Built using HTML, CSS, and JavaScript for a responsive experience. Markdown Preview: Supports real-time preview and manual editing of generated content.

⚙️ Backend Layer

Node.js & Express: A robust server that orchestrates all GitHub API interactions. GitHub REST API: Deeply integrates with GitHub to parse repository files and structures.

🤖 AI Provider Layer

AutoDoc.ai supports multiple LLM providers through a configurable provider abstraction layer.

Supported providers include:

• OpenAI
• Gemini
• Anthropic
• NVIDIA
• Custom OpenAI-compatible providers

The active provider is selected through environment configuration using the LLM_PROVIDER setting.

🎨 Technology Badges

Category	Badges
Frontend Foundation
Core
Integrations

---

🗺️ Roadmap

AutoDoc.ai is continuously evolving to provide a better documentation experience for developers and open-source contributors.

graph TD
    Root["🚀 AutoDoc.ai Roadmap"]

    Root --> P1["📦 Foundation"]
    P1 --> P1_1["✅ Modern React + Vite Frontend"]
    P1 --> P1_2["✅ Documentation Generator Interface"]
    P1 --> P1_3["✅ Contributors Showcase"]

    Root --> P2["⚡ Core Features"]
    P2 --> P2_1["🔄 Enhanced Documentation Generation"]
    P2 --> P2_2["📄 Export Improvements"]
    P2 --> P2_3["🎨 Improved User Experience"]

    Root --> P3["🤖 AI Integration"]
    P3 --> P3_1["💡 Intelligent Documentation Suggestions"]
    P3 --> P3_2["📝 README Generation Assistance"]
    P3 --> P3_3["🔍 Repository Analysis Features"]

    Root --> P4["🌍 Open Source Growth"]
    P4 --> P4_1["📚 Better Contributor Resources"]
    P4 --> P4_2["🧪 Expanded Testing"]
    P4 --> P4_3["🚀 Deployment & Automation"]

Loading

Current Progress

Foundation               ████████████████████  Complete ✅
Core Features            ██████████░░░░░░░░░░  In Progress 🚧
AI Integration           ███░░░░░░░░░░░░░░░░░  Planned 📋
Open Source Growth       ██░░░░░░░░░░░░░░░░░░  Future 💡

Planned Improvements

🎨 User Experience

• Improve UI responsiveness across devices
• Enhance accessibility and usability
• Refine navigation and page layouts

📄 Documentation Features

• Improve generated documentation quality
• Add additional export options
• Expand customization capabilities

🤖 AI-Powered Enhancements

• Intelligent documentation assistance
• Repository structure analysis
• Context-aware content suggestions

🌐 Open Source Development

• Increase test coverage
• Improve contributor onboarding
• Add automated workflows and CI/CD support
• Expand community-driven contributions

---

🌟 Contributing

AutoDoc.ai thrives because of contributors like you. Whether you're fixing a typo, building a feature, or improving AI prompts — every contribution matters and is recognized.

🏆 Open Source Programs

Program	Event	Timeline	Status
	Social Summer of Code	Summer 2026	🟢 Active

Note

AutoDoc.ai is an SSOC-selected project. Contributing during the program window earns you official SSOC points, certificates, and recognition on the leaderboard. All accepted PRs during the event will be labeled ssoc.

🚀 How to Get Involved

We're currently in the Open Source Readiness phase and actively welcoming contributors of all skill levels.

For Beginners 🌱

• Fix typos, grammar, or formatting in documentation
• Add missing code comments or docstrings
• Improve error messages for better developer experience
• Write or improve existing tests

For Intermediate Contributors 🌿

• Implement documentation quality scoring
• Add support for additional AI providers (OpenAI, Cohere, etc.)
• Improve GitHub API rate-limit handling and caching
• Build new export formats (PDF, HTML, Notion)

For Advanced Contributors 🌳

• Design the GitHub App integration (Phase 3)
• Architect the plugin system (Phase 4)
• Implement PR-based documentation suggestion workflows
• Build the community prompt template marketplace

🛤️ Contribution Workflow

# 1. Fork the repository on GitHub

# 2. Clone your fork
git clone https://github.com/YOUR_USERNAME/AutoDoc.ai.git
cd AutoDoc.ai

# 3. Create a descriptive feature branch
git checkout -b feat/your-feature-name
# or: fix/bug-description | docs/update-section | test/add-coverage

# 4. Make your changes with clear, atomic commits
git commit -m "feat: add documentation quality scoring UI"

# 5. Push and open a Pull Request
git push origin feat/your-feature-name

📋 Pull Request Checklist

Before submitting your PR, ensure:

• Code follows the existing style conventions
• New features include appropriate tests
• Documentation is updated to reflect changes
• The PR description clearly explains what and why
• All existing tests pass locally
• No sensitive data (API keys, tokens) is committed

Tip

Read the full CONTRIBUTING.md for detailed environment setup, coding standards, commit message conventions, and pull request guidelines.

🏅 Contributor Recognition

All contributors are featured on our Contributors page and in the project README. Significant contributors will be recognized with special badges and invited to join the maintainer team.

Local Development

This project requires an LLM provider to generate repository documentation. Since API keys cannot be included in a public repository, contributors must configure their own provider before running the project locally.

Why is this setup required?

The documentation generator depends on external AI models to analyze repositories and generate documentation. Without a valid LLM provider and API key, the application will not be able to process repositories correctly.

To make local development easier, contributors can use OpenRouter, which provides access to multiple reasoning models through a single API.

OpenRouter Configuration

1. Create a free account on OpenRouter.
2. Generate an API key from the dashboard.
3. Copy .env.example to .env.
4. Configure the following environment variables:

LLM_PROVIDER=openai
OPENAI_API_KEY=your_openrouter_api_key
OPENAI_BASE_URL=https://openrouter.ai/api/v1
OPENAI_MODEL=openai/gpt-4o-mini

You may use any supported reasoning model available through OpenRouter for local development and testing.

Common Setup Issues

Issue	Solution
Set LLM_PROVIDER to openai...	Verify that LLM_PROVIDER is set correctly in the .env file.
Unexpected end of JSON input	Check your API key and ensure the provider is configured properly.
Documentation generation fails	Verify that the API key is valid and the development server has been restarted after updating .env.

Quick Checklist

Before running the project, ensure that:

• .env has been created from .env.example
• A valid OpenRouter API key has been added
• LLM_PROVIDER is configured correctly
• Dependencies have been installed
• The development server has been restarted after configuration changes

---

📄 License and Maintainer

📜 License

This project is licensed under the MIT License.

The MIT License ensures AutoDoc.ai remains forever free and open — use it in your academic projects, hackathons, startup products, or enterprise workflows without restriction. We only ask that you keep the license notice intact and consider contributing improvements back to the community.

Copyright (c) 2026 Abhro

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction...

👨‍💻 Maintainer

❄️ Abhro Full-Stack Developer · Data Science Specialization

Building tools that make developers' lives easier, one commit at a time.

---

Made with ❤️ by the AutoDoc.ai community

"Because great code deserves great documentation."

_{© 2026 AutoDoc.ai · MIT Licensed · Open Source Forever}