dev-doc 0.2.11 → 0.2.13

package/README.md

@@ -6,9 +6,9 @@ AI-powered codebase analyzer that automatically generates comprehensive document
 
 `dev-doc` scans your codebase, analyzes it with AI, and generates detailed documentation including:
 - **API Documentation**: Automatically detects and documents all endpoints, their relationships, and authentication flows
-- **Project Architecture**: Understands your tech stack and explains the overall structure
-- **Code Insights**: Provides explanations of functions, classes, and their roles
-- **Dependencies**: Maps relationships between different parts of your codebase
+- **Structured Analysis**: Organized documentation with overview, architecture, tech stack, and key features
+- **Code Optimization Insights**: Actionable recommendations to improve performance, reduce latency, and enhance code quality
+- **Project Organization**: Clear ownership tracking with project names for easy management
 
 All documentation is securely stored in your dashboard where you can access it anytime.
 
@@ -49,17 +49,30 @@ You'll see a confirmation with your quota and usage information.
 
 ### Step 4: Analyze Your Codebase
 
+```bash
+dev-doc
+```
+
+Or analyze a specific directory:
+
 ```bash
 dev-doc ./src
 ```
 
-That's it! Your analysis will be automatically processed and saved to your dashboard.
+That's it! Your analysis will be processed in the background and saved to your dashboard. The CLI will exit immediately after queuing the analysis.
+
+**Note:** Running `dev-doc` without arguments analyzes the current directory, making it perfect for running from your project root.
 
 ## 📖 Usage
 
 ### Basic Commands
 
-**Analyze a directory:**
+**Analyze current directory:**
+```bash
+dev-doc
+```
+
+**Analyze a specific directory:**
 ```bash
 dev-doc ./src
 ```
@@ -76,40 +89,58 @@ dev-doc add-key <your-api-key>
 
 ### Options
 
+**Specify a custom project name:**
+```bash
+dev-doc ./src --project-name "my-awesome-project"
+```
+
 **Ignore specific directories:**
 ```bash
 dev-doc ./src --ignore node_modules,dist,tests,.next
 ```
 
-Default ignored directories: `node_modules`, `.git`, `dist`, `build`, `.next`
+**Default behavior:**
+- Project name is automatically extracted from `package.json` (if present) or the directory name
+- Default ignored directories: `node_modules`, `.git`, `dist`, `build`, `.next`
 
 ## 📋 Examples
 
-### Analyze your entire project
+### Analyze current directory (most common)
 
 ```bash
-dev-doc .
+dev-doc
 ```
 
+This analyzes the current directory - perfect when you're in your project root!
+
 ### Analyze a specific directory
 
 ```bash
 dev-doc ./src
 dev-doc ./backend
-dev-doc ./packages/utils
+```
+
+### Analyze with custom project name
+
+```bash
+dev-doc --project-name "api-backend"
+dev-doc ./src --project-name "api-backend"
 ```
 
 ### Exclude test files and build directories
 
 ```bash
+dev-doc --ignore tests,coverage,build,.next
 dev-doc ./src --ignore tests,coverage,build,.next
 ```
 
 ## 🎯 Features
 
 - **🔍 Smart Detection**: Automatically identifies APIs, endpoints, and their relationships
-- **⚡ Fast & Efficient**: Only processes changed files on subsequent runs
-- **📊 Comprehensive**: Generates both high-level architecture and detailed file-by-file documentation
+- **⚡ Background Processing**: Analysis runs asynchronously - no waiting for completion
+- **📊 Structured Documentation**: Organized into separate fields (overview, architecture, APIs, tech stack)
+- **🎯 Optimization Insights**: Actionable recommendations for performance, latency, and code quality
+- **📦 Project Organization**: Clear project naming and ownership tracking
 - **🔒 Secure**: Your code is processed securely and stored in your private dashboard
 - **🚀 No Configuration**: Works out of the box with sensible defaults
 
@@ -117,14 +148,43 @@ dev-doc ./src --ignore tests,coverage,build,.next
 
 After running an analysis, you'll have access to:
 
-- **Complete API Documentation**: Every endpoint with parameters, responses, and relationships
-- **Authentication Flows**: Documented auth patterns and token usage
-- **Project Summary**: High-level overview of your architecture and tech stack
-- **File Documentation**: Detailed explanations of each file's purpose and key functions
-- **Dependency Mapping**: Clear understanding of how different parts connect
+### **Structured Documentation**
+- **Overview**: Brief project description
+- **Architecture**: Detailed system architecture and design patterns
+- **Tech Stack**: Complete list of frameworks, libraries, and tools used
+- **API Endpoints**: Comprehensive list of all endpoints with methods, paths, descriptions, and authentication requirements
+- **Key Features**: List of main functionality and capabilities
+- **Dependencies**: Core package dependencies
+
+### **API Documentation**
+- Every endpoint with HTTP methods and paths
+- Authentication and authorization requirements
+- API relationships and dependencies
+- Data flows between endpoints
+
+### **Code Optimization Insights**
+- **Performance Bottlenecks**: Identifies N+1 queries, missing indexes, inefficient algorithms
+- **API Latency Improvements**: Caching strategies, query optimizations, response compression suggestions
+- **Code Quality Enhancements**: Code smells, refactoring opportunities, security improvements
+- **Architecture Improvements**: Better patterns, scalability suggestions, maintainability enhancements
+
+### **Project Summary**
+- High-level overview of your architecture and tech stack
+- Complete API endpoint catalog
+- Authentication flows and patterns
+- File-by-file analysis documentation
 
 All documentation is accessible through your dashboard at [devdoc.tellecata.com](https://devdoc.tellecata.com).
 
+## 🔄 How It Works
+
+1. **Queue Analysis**: CLI sends your codebase to the backend and receives immediate confirmation
+2. **Background Processing**: Analysis runs asynchronously on the server (no timeout issues)
+3. **AI Analysis**: Files are analyzed for APIs, architecture, and code patterns
+4. **Structured Extraction**: Documentation is organized into structured fields
+5. **Storage**: Results are saved to your dashboard with clear project ownership
+6. **Access**: View comprehensive documentation anytime in your dashboard
+
 ## ❓ Troubleshooting
 
 **No API key found?**
@@ -137,6 +197,11 @@ dev-doc add-key <your-api-key>
 dev-doc status
 ```
 
+**Project name not detected?**
+```bash
+dev-doc ./src --project-name "my-project"
+```
+
 **Need help?** Visit [devdoc.tellecata.com](https://devdoc.tellecata.com) for support and documentation.
 
 ## 📄 License

package/dist/cli.js

@@ -47,7 +47,7 @@ const API_URL = "https://dev-doc-726dc734499e.herokuapp.com"; // TODO: Update to
 program
     .name("dev-doc")
     .description("AI-powered codebase analyzer AI")
-    .version("0.2.11");
+    .version("0.2.13");
 // Add API key command
 program
     .command("add-key")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dev-doc",
-  "version": "0.2.11",
+  "version": "0.2.13",
   "description": "AI-powered codebase analyzer using AI to generate documentation and insights",
   "main": "dist/index.js",
   "bin": {