GenDocX is a VS Code extension that automatically generates comprehensive, professional README files for your projects by analyzing your codebase using AI.
Features
One-Click README Generation: Create detailed README.md files with a single command
Smart Project Analysis: Automatically identifies technologies, dependencies, and key project features
Professional Documentation: Creates well-structured, Markdown-formatted documentation that follows best practices
Comprehensive Content: Includes project description, installation instructions, usage examples, API documentation, and more
Customizable Output: Use the generated README as a solid foundation, then customize it to your needs
Installation
Open VS Code
Go to the Extensions view (Ctrl+Shift+X)
Search for "GenDocX"
Click Install
Requirements
VS Code 1.97.0 or newer
A MindsDB API key (see Configuration section)
Usage
Open your project in VS Code
Run the command GenDocX: Generate README from the Command Palette (Ctrl+Shift+P)
If you haven't configured your API key yet, you'll be prompted to enter it
Wait while GenDocX analyzes your project and generates your README
Review and customize the generated README.md file
Configuration
To set your MindsDB API key:
Run the command GenDocX: Configure API Key from the Command Palette
Enter your MindsDB API key when prompted
The key will be securely stored in your VS Code settings
Alternatively, you can set it in your settings.json file:
{
"gendocx.mindsdbApiKey": "your-api-key-here"
}
How It Works
GenDocX performs a comprehensive analysis of your codebase:
Project Discovery: Identifies main files, configuration files, and key source files
Technology Detection: Detects frameworks, libraries, and technologies used in your project
Structure Analysis: Maps your project's directory structure
AI-Powered Documentation: Utilizes MindsDB's AI to generate detailed, accurate documentation
Markdown Formatting: Structures the README with proper headings, code blocks, and formatting
Extension Settings
This extension contributes the following settings:
gendocx.mindsdbApiKey: MindsDB API key for README generation
Known Issues
Currently supports JavaScript, TypeScript, Python, and other common languages. More specialized language support coming soon.
GenDocX sends your project structure and sample code snippets to MindsDB for analysis. No data is stored beyond what's necessary for generating your README.
