Doxpert.ai VS Code Extension

Generate comprehensive project documentation directly from your IDE with AI-powered analysis and documentation generation.

Features

🚀 Instant Documentation Generation

README Generation: Automatically create comprehensive README files based on your codebase
API Documentation: Extract and document API endpoints from your code
Architecture Documentation: Generate system architecture and design documentation
Setup Guides: Create installation and setup instructions
Contributing Guidelines: Generate contribution guidelines for your project

🔍 Intelligent Code Analysis

Multi-language Support: TypeScript, JavaScript, Python, Java, C#, Go, Rust
Framework Detection: Automatically detect React, Vue, Angular, Express, FastAPI, Spring, and more
Dependency Analysis: Analyze package.json, requirements.txt, pom.xml, and other dependency files
Complexity Metrics: Calculate cyclomatic complexity and maintainability index
API Endpoint Detection: Find and catalog REST API endpoints

🔄 Seamless Integration

Real-time Sync: Sync your documentation with Doxpert.ai platform
Project Management: View and manage your Doxpert.ai projects from VS Code
Auto-sync: Automatically update documentation when files change
Git Integration: Generate documentation on commits (optional)

📊 Project Insights

Codebase Overview: Get a bird's-eye view of your project structure
Quality Metrics: Track code quality and technical debt
Documentation Coverage: Identify areas that need documentation
Progress Tracking: Monitor documentation completeness

Installation

From VS Code Marketplace

Open VS Code
Go to Extensions (Ctrl+Shift+X)
Search for "Doxpert.ai"
Click Install

From Command Line

code --install-extension doxpert-ai.doxpert-ai

Quick Start

1. Authentication

Open Command Palette (Ctrl+Shift+P)
Run Doxpert: Authenticate
Enter your Doxpert.ai API key (get it from Doxpert.ai Settings)

2. Generate Documentation

Right-click on a folder in Explorer
Select Doxpert: Generate Documentation
Wait for AI analysis and generation
Review generated documentation in the docs/ folder

3. Sync with Platform

Run Doxpert: Sync with Doxpert.ai
Your project and documentation will be synced to the platform
Access advanced features on the web platform

Commands

Command	Description	Shortcut
`Doxpert: Generate Documentation`	Generate comprehensive project documentation	-
`Doxpert: Generate README`	Generate README.md file	-
`Doxpert: Generate API Documentation`	Extract and document API endpoints	-
`Doxpert: Analyze Codebase`	Perform detailed codebase analysis	-
`Doxpert: Sync Project`	Sync with Doxpert.ai platform	-
`Doxpert: Authenticate`	Set up API authentication	-

Configuration

Settings

Access settings via File > Preferences > Settings, then search for "Doxpert"

Setting	Description	Default
`doxpert.apiKey`	Your Doxpert.ai API key	-
`doxpert.autoSync`	Automatically sync on file changes	`true`
`doxpert.generateOnCommit`	Generate docs on git commits	`false`

API Key Setup

Visit Doxpert.ai
Go to Settings > API Keys
Generate a new API key
Copy the key to VS Code settings

Supported Languages & Frameworks

Languages

TypeScript/JavaScript - Full support with JSDoc extraction
Python - Docstring and type hint analysis
Java - Javadoc and annotation support
C# - XML documentation and attribute analysis
Go - Comment and interface analysis
Rust - Doc comment and trait analysis

Frameworks

Frontend: React, Vue.js, Angular, Svelte
Backend: Express.js, FastAPI, Spring Boot, ASP.NET Core, Django, Flask
Mobile: React Native, Flutter (Dart support coming soon)
Desktop: Electron, Tauri

API Documentation

REST APIs - Automatic endpoint detection
GraphQL - Schema and resolver analysis
OpenAPI/Swagger - Specification generation
Postman - Collection export

Generated Documentation Types

📋 README.md

Project overview and description
Installation instructions
Usage examples
Technology stack
Project structure
Contributing guidelines

📚 API Documentation

Endpoint catalog with methods and paths
Parameter descriptions
Response schemas
Authentication requirements
Code examples in multiple languages

🏗️ Architecture Documentation

System overview
Component relationships
Data flow diagrams
Technology decisions
Performance considerations

⚙️ Setup Guide

Development environment setup
Dependency installation
Configuration instructions
Troubleshooting guide

🤝 Contributing Guide

Development workflow
Code style guidelines
Testing requirements
Pull request process

Workspace Integration

Project Tree View

View your Doxpert.ai projects in the sidebar
Quick access to project documentation
Real-time sync status

Context Menus

Right-click folders to generate documentation
Right-click files to generate API docs
Quick actions for common tasks

Status Bar

Shows connection status
Quick access to documentation generation
Sync progress indicator

Advanced Features

Codebase Analysis

Complexity Metrics: Cyclomatic complexity, maintainability index
Dependency Graph: Visualize project dependencies
Code Coverage: Integration with testing frameworks
Security Analysis: Basic security pattern detection

AI-Powered Features

Smart Descriptions: AI-generated descriptions for functions and classes
Documentation Suggestions: Recommendations for missing documentation
Code Quality Insights: Automated code review suggestions
Template Matching: Apply documentation templates based on project type

Integration Capabilities

Git Hooks: Auto-generate docs on commits
CI/CD: Integration with GitHub Actions, GitLab CI
Webhooks: Real-time updates from repository events
Export Options: PDF, Word, HTML export

Troubleshooting

Common Issues

Extension not loading

Restart VS Code
Check if you have the latest version
Verify VS Code version compatibility

Authentication failed

Verify your API key is correct
Check internet connection
Ensure API key has proper permissions

Documentation not generating

Check if the project contains supported file types
Verify workspace folder is properly opened
Look for error messages in Output panel

Sync issues

Check authentication status
Verify project exists on Doxpert.ai platform
Check network connectivity

Getting Help

Documentation: docs.doxpert.ai
Support: support@doxpert.ai
Issues: GitHub Issues
Community: Discord Server

Privacy & Security

Local Analysis: Code analysis happens locally on your machine
Secure Transmission: All data is encrypted in transit
No Code Storage: We don't store your source code on our servers
API Key Security: Keys are stored securely in VS Code settings
GDPR Compliant: Full compliance with data protection regulations

Changelog

v1.0.0 (Latest)

Initial release
Basic documentation generation
Multi-language support
Doxpert.ai platform integration
Real-time sync capabilities

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This extension is licensed under the MIT License. See LICENSE for details.

Made with ❤️ by the Doxpert.ai team

Transform your development workflow with AI-powered documentation generation. Get started today!

Doxpert.ai - AI Documentation Assistant

Doxpert