DocWeaver - Automated Project Documentation for VS Code

Generate comprehensive project documentation with AI-powered analysis

🎯 Overview

DocWeaver is a VS Code extension designed to generate structured and concise documentation for projects. It automatically analyzes code files, extracts key technical details, and compiles comprehensive documentation, including project structure and inter-file relationships.

✨ Features

• Automated Code Summarization: Extracts imports, functions, classes, and overall file functionality
• Project-Wide Documentation: Generates technical documentation at the project level using file summaries
• Module-Level Summaries: Analyzes submodules for a structured understanding
• Project Structure Tree View: Visualizes the file hierarchy within VS Code
• Customizable Prompts: Users can modify summarization prompts to fit their needs
• Supports OpenAI & Ollama: Choose between OpenAI's GPT models or local Ollama-based processing
• Markdown Export: Saves generated documentation to structured Markdown files

📦 Installation

1. Install directly from the VS Code Marketplace
2. Or install from within VS Code:
   • Open VS Code
   • Open the Extensions view (Ctrl+Shift+X / Cmd+Shift+X)
   • Search for "DocWeaver"
   • Click Install
3. Restart VS Code to activate the extension

🚀 Usage

Generating Documentation

1. Open a project in VS Code
2. Use the command palette (Ctrl+Shift+P / Cmd+Shift+P on Mac)
3. Run DocWeaver: Document Project
4. View logs in the "DocWeaver" output channel
5. The generated documentation will be available in a DocsWeaver folder within your workspace

Viewing Documentation

• Open PROJECT_DOCUMENTATION.md from the DocsWeaver folder
• Use the built-in webview to preview the documentation inside VS Code
• View individual file summaries stored in Markdown format within the DocsWeaver directory

Customization

DocWeaver allows users to modify its behavior via VS Code settings (Settings > Extensions > DocWeaver):

🔧 Dependencies

• vscode - Extension API
• fs, path - File system utilities
• ignore - .gitignore parsing
• axios - HTTP requests for API communication
• marked - Converts Markdown to HTML for the webview

❓ Troubleshooting

Common Issues & Fixes

• No documentation generated: Ensure your workspace has valid files and is not empty
• Files are being skipped: Check .gitignore and docweaver.ignorePatterns settings
• API errors: Verify API keys or ensure the Ollama server is running

📄 License

This extension is open-source and distributed under the MIT License.

🤝 Contributing

Contributions are welcome! Feel free to submit issues or pull requests on GitHub.

👤 Author

Developed by itsabk. Reach out via GitHub or email for support.