DocForge
Automatically generate project documentation — README, API docs, code comments, architecture overview, and changelog — right from VS Code.
✨ Features
| Feature |
Description |
| 📘 README Generator |
Analyze package.json and project structure to generate a professional README.md |
| 🌐 API Docs Generator |
Detect Express, FastAPI, Flask, Fastify, and NestJS routes and generate API documentation |
| 💬 Code Comment Generator |
Add JSDoc / docstring comments to functions and classes in the active editor |
| 🏗️ Architecture Analyzer |
Detect project patterns, layers, and frameworks; generate an architecture overview with Mermaid diagrams |
| 📋 Changelog Generator |
Parse Git commit history using conventional commits to create a CHANGELOG.md |
| 📊 Dashboard |
Interactive webview panel showing project info and one-click generation buttons |
🚀 Getting Started
Install from Source
git clone <repo-url>
cd docforge
npm install
npm run compile
Then press F5 in VS Code to launch the Extension Development Host.
From Marketplace
Search for DocForge in the VS Code Extensions panel.
📋 Commands
Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and type DocForge:
| Command |
Description |
DocForge: Generate README |
Generate a README.md from project metadata |
DocForge: Generate API Docs |
Scan and document API routes |
DocForge: Generate Comments |
Add doc comments to the active file |
DocForge: Generate Architecture |
Create an architecture overview |
DocForge: Generate Changelog |
Generate changelog from Git history |
DocForge: Open Dashboard |
Open the interactive dashboard panel |
DocForge adds a dedicated sidebar panel to the Activity Bar:
DocForge
├── Generate README
├── Generate API Docs
├── Generate Comments
├── Generate Architecture
├── Generate Changelog
└── Open Dashboard
⚙️ Configuration
| Setting |
Default |
Description |
docforge.aiProvider |
none |
AI provider: none, openai, or gemini |
docforge.apiKey |
"" |
API key for the selected AI provider |
docforge.aiModel |
gpt-4o-mini |
AI model to use |
docforge.outputDirectory |
docs |
Directory for generated documentation files |
Note: DocForge works without AI using intelligent template-based generation. AI is optional and enhances quality.
🔌 Supported Frameworks
API Route Detection:
- Express.js
- Fastify
- NestJS
- FastAPI (Python)
- Flask (Python)
Language Detection:
TypeScript, JavaScript, Python, Java, Go, Rust, Ruby, PHP, C#, C++, Swift, Kotlin, Dart, Vue, Svelte
📁 Project Structure
docforge/
├── src/
│ ├── extension.ts # Entry point
│ ├── engine/
│ │ ├── readmeGenerator.ts # README generation
│ │ ├── apiDocGenerator.ts # API documentation
│ │ ├── commentGenerator.ts # Code comments
│ │ ├── architectureAnalyzer.ts # Architecture overview
│ │ └── changelogGenerator.ts # Changelog from git
│ ├── scanner/
│ │ ├── projectScanner.ts # Project metadata scanner
│ │ └── routeScanner.ts # API route detector
│ ├── services/
│ │ ├── aiService.ts # AI integration (OpenAI/Gemini)
│ │ └── gitService.ts # Git operations
│ ├── ui/
│ │ ├── sidebarProvider.ts # TreeView sidebar
│ │ └── webviewDashboard.ts # Dashboard panel
│ ├── utils/
│ │ ├── fileReader.ts # File I/O utilities
│ │ └── markdownBuilder.ts # Markdown builder
│ └── types/
│ └── docTypes.ts # TypeScript interfaces
├── assets/
│ └── icon.png
├── package.json
├── tsconfig.json
└── README.md
📜 License
MIT © DocForge
