📚 DocGenie: AI-Powered Documentation Assistant for VS Code
Welcome to DocGenie — your all-in-one documentation assistant for Visual Studio Code! DocGenie automates codebase analysis, generates and improves documentation, and helps you keep your project docs up-to-date with ease. Whether you're a developer, technical writer, or project manager, DocGenie streamlines your workflow and boosts documentation quality.
✨ Key Features
- Automated Codebase Analysis
- Scans the workspace to summarize architecture and extract documentation from markdown files.
- Documentation Generation
- Generates architecture overviews and project documentation using AI-powered prompts.
- Documentation Improvement
- Enhances existing markdown documentation with suggestions and improvements from language models.
- Chat-Based Commands
- Integrates with VS Code's chat API for interactive documentation commands.
- Concurrent Processing
- Efficiently handles large codebases with batching and concurrency utilities.
- Persistent State Management
- Tracks active requests and stores global state for seamless user experience.
🚀 Main Commands & Usage
- ScanDocs: Analyze the workspace and extract documentation.
- ImproveDocs: Enhance existing documentation using AI.
- GenerateDocs: Create new documentation and architecture summaries.
- Chat Participant ("DocGenie"): Interact via VS Code's chat for documentation tasks.
🏁 Quickstart Guide
Installation Requirements
- Visual Studio Code (v1.106.0 or higher)
- Internet Connection (for AI-powered features)
- (Optional) GitHub Copilot for enhanced chat experience
How to Use DocGenie
A. Using Chat Commands
- Open the Copilot or VS Code chat panel
- Type
@DocGenie and your request (e.g., ScanDocs, GenerateDocs, ImproveDocs)
- Follow the prompts and review the results in your workspace
B. Conversational Workflow
- Ask DocGenie questions about your documentation or codebase
- Get instant suggestions, improvements, and summaries
📈 Tracking Your Progress
- Watch progress updates in the VS Code output panel
- Receive notifications when tasks complete
- Monitor ongoing documentation generation and improvements
🌟 Key Benefits
- Save Time: Automate tedious documentation tasks
- Improve Quality: AI-powered insights ensure comprehensive coverage
- Stay Organized: Keep documentation in sync with your code
- Work Seamlessly: Never leave your VS Code environment
- Scale Effortlessly: Handle large workspaces with batch processing
🔒 Security & Privacy
DocGenie processes your code and documentation locally within the VS Code environment. When using AI-powered features, code snippets and documentation may be sent to language model services for analysis and generation. No data is stored or shared beyond these interactions.
❓ Frequently Asked Questions
Q: Do I need to know how to code to use DocGenie?
A: No. DocGenie is user-friendly—simply use the chat interface to interact with the extension.
Q: Can DocGenie work with any programming language?
A: Yes. DocGenie is language-agnostic and can analyze and document code in any language.
Q: Will DocGenie overwrite my existing documentation?
A: DocGenie provides suggestions for improving documentation. You can review and apply changes as needed.
Q: How does DocGenie handle large projects?
A: DocGenie processes files in batches for efficient handling of large workspaces.
Q: Does DocGenie require GitHub Copilot?
A: No. DocGenie integrates with language models via prompt utilities and does not require GitHub Copilot.
Q: How are commands handled?
A: Commands are registered with the VS Code command system and routed to handlers in the participant services layer.
🛠️ Troubleshooting & Best Practices
Common Issues:
- If DocGenie doesn't respond, ensure you have an active internet connection and the latest VS Code version.
- For authentication issues, sign in to GitHub via VS Code.
- If documentation is not generated as expected, check your workspace structure and try rescanning.
Best Practices:
- Regularly scan and improve docs to keep them up-to-date
- Review AI-generated suggestions before applying
- Use clear, descriptive commit messages when updating documentation
💬 Support & Feedback
Have questions, issues, or suggestions? We'd love to hear from you!
- Open an issue or discussion on the project repository
- Reach out via your team's preferred support channel
📄 License
DocGenie is released under the MIT License.
