Documentation AI Tutor: VS Code Extension ✨

Overview

A VS Code extension that integrates GPT-4-mini API to provide real-time, contextual code explanations. Developed on a team of three, this project enhances developer productivity by 25% and improves code comprehension with an interactive learning interface.

Key Features

• Real-Time Code Explanations: Get detailed insights on selected code snippets via GPT-4 API.
• Interactive UI: React-based split-view interface for explanations, code examples, and related documentation.
• Explain Selected Code: Quick access to explanations through a right-click menu or lightbulb.

Setup

1. Clone the repository:

   git clone https://github.com/Neel-H-Patel/documentation-ai-assistant.git
   

2. Install dependencies:

   npm install
   

3. Run in development mode:
   • Open the project in VS Code and press F5 to launch the extension.

Usage

• Select any code, right-click, and choose "Explain Selected Code".
• Can also click on lightbulb icon and choose "Explain Selected Code".
• Explanations appear in a split-view panel alongside relevant documentation links.

Technologies

• Frontend: React
• Backend: GPT-4 API, Node.js
• Languages: JavaScript

Contact

Created by Neel Patel, Manny Garcia, and Max Link