/DocuGen

DocuGen - Shifting from Manual to Automated Documentation Using AI

Primary LanguageJavaScript

πŸš€ DocuGen AI πŸš€

Shifting from Manual to Automated Documentation

Perfect for developers, project managers, and new team members looking to understand business logic faster

A powerful AI powered VS Code extension that scans your repository and generates a markdown based documentation of your code!

✨ Where did the idea come from?

  • Tired of messy, outdated & incomplete documentation

✨ Why do we care about this idea?

  • Creating & updating documentation manually is a pain staking effort & we wanted to automate this process using Azure Open AI

✨ How does this relate to your day jobs, if at all?

  • We spend everyday delivering so many features & releases on daily basis to our customers including painful & manual documentation. Imagine a newly onboarded team member asking you to explain the code 😰

✨ Who is this project for?

  • Developers, Project Managers & Newly onboarded team members

✨ Why is this solution different and compelling for the customer?

  • Standardization of documentation across multiple projects throughout the organization provides a greater value addition on daily basis

✨ Key Features:

  • Automatically generates & updated documentation from your code
  • Summarizes code using OpenAI models or Ollama integration
  • Standardized, AI-powered documentation templates
  • Seamless VS Code integration with real-time updates
  • Seamless GitHub Actions integration with automated documentation via existing PR pipeline

βš™οΈ Upcoming Releases:

  • Generate business logic documentation from multiple repositories
  • DevOps integration for automated document updating
  • Support for Visual Studio and more platforms!
  • Integrations with following providers
    • Claude
    • Mistral
    • Cohere
    • Groq
    • DeepSeek
    • Together AI
    • Gemini
    • LM Studio
    • llama
    • SambaNova Cloud
    • Cerebras
    • OpenRouter

πŸ‘©β€πŸ’» Make software development more efficient with instant, consistent code documents, whether you're onboarding, reviewing, or managing projects!

πŸ‘‰ Join us on this exciting journey! We’d love your feedback and support.

πŸ‘‰ Don’t forget to like, bookmark, and spread the word if you’re excited for automated documentation with DocuGen! πŸ’‘

Example GitHub Actions Integration

View example configuration

This example demonstrates how to integrate using GitHub Actions.

Visual Studio Code Extension

Install from Marketplace for VS Code