DocumentationGenerator

Documentation Generator

An intelligent workflow automation system that fetches code from GitHub, analyzes its structure, generates comprehensive technical documentation, and automatically updates Confluence pages. This system uses LangGraph for multi-agent orchestration, OpenAI for code analysis, and Streamlit for an interactive user interface.

🚀 Key Features

• GitHub Integration: Dynamically fetch source code from any GitHub repository
• AI-Powered Analysis: Analyze code structure, functions, and purpose using OpenAI LLMs
• Automated Documentation: Generate detailed technical documentation in Markdown format
• Confluence Integration: Automatically update Confluence pages with generated documentation
• Multi-Agent Workflow: Orchestrate the entire process using LangGraph's AI agents
• Interactive UI: User-friendly Streamlit interface for easy operation
• Mock Testing Mode: Test the application without any actual API keys or credentials

🛠️ Tech Stack

• LangGraph: AI-powered multi-agent workflow automation
• OpenAI GPT-4: Intelligent code analysis and documentation generation
• GitHub API: Fetching repository contents
• Confluence API: Updating documentation pages
• Streamlit: Web UI for user interaction
• Python: Core application logic

📋 Prerequisites

• Python 3.8 or higher
• GitHub Personal Access Token
• Confluence API credentials
• OpenAI API key

🔧 Installation

1. **Clone the repository**

   git clone https://github.com/sylvester-francis/DocumentationGenerator.git
   cd DocumentationGenerator

2. **Set up the environment**

   # Run the setup script
   bash setup.sh
   
   # Or manually:
   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   pip install -r requirements.txt

3. **Configure environment variables**

   Copy the `.env.sample` file to `.env` and add your API keys:

   cp .env.sample .env
   #