+---
-## Code GPT extension repository
-
-- https://github.com/davila7/codegpt
+## VSCode Extension
+[Download from VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=DanielSanMedium.dscodegpt)
-That repository is private for the moment, since the code is being prepared to be published as open source.
-I am working very hard to have a good path to receive contributions, it will soon be published on the https://codegpt.co page and in the official communities to start collaborating on the project. I appreciate your patience.
+## Jetbrains Plugin
+[Download from Jetbrains Marketplace](https://plugins.jetbrains.com/plugin/24372-codegpt-chat--ai-agents)
-## Code GPT Docs repository
-In this repository you will find all the documentation about the extension, Tips for Writing Queries, news about upcoming updates and more.
+## Visual Studio Enterprise
+[Download from Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=DanielSanMedium.CodeGPT)
-## Ways to contribute:
+## Extension Documentation
+[View Extension Docs](https://docs.codegpt.co)
-- Writing a new article
-- Translating articles
-- Giving feedback and in the community of [Discord](https://discord.gg/xc5RcH5n), [Facebook](https://www.facebook.com/groups/1590127588169761) and [Reddit](https://www.reddit.com/r/CodeGPT_VSCode/).
+## API Documentation
+[View API Docs](https://developers.codegpt.co/)
-### Install
-```
-$ npm i
-```
+## New Features
+- **Login Button**: A new login button has been added to the navigation bar for easier access to the CodeGPT application.
-### Start project
+## Join Our Community
+We believe in collaboration and feedback, which is why we encourage you to get involved in our vibrant and welcoming Discord community. Feel free to ask questions, suggest new features, and share your experience with fellow coders.
+[Click here to join our Discord.](https://discord.gg/vgTGsVr69s)
-```
-$ npm start
-```
+## Reporting Issues on GitHub
+To help us improve CodeGPT, please document issues you encounter by following these steps:
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+1. **Short Title**
+2. **Steps to Reproduce**: Provide a step-by-step description of how to reproduce the issue.
+3. **Expected Behavior**: Describe what you expected to happen.
+4. **Actual Behavior**: Describe what actually happened.
+5. **Screenshots**: Attach screenshots if applicable.
+6. **Environment**: Specify your OS (e.g., Windows, macOS, Linux), Browser (if applicable), and CodeGPT version.
+7. **Additional Information**: Include any relevant logs or references.
diff --git a/assets/add-credits-flux.gif b/assets/add-credits-flux.gif
new file mode 100644
index 00000000..94e42a2f
Binary files /dev/null and b/assets/add-credits-flux.gif differ
diff --git a/assets/autocomplete_landing.gif b/assets/autocomplete_landing.gif
new file mode 100644
index 00000000..5d457918
Binary files /dev/null and b/assets/autocomplete_landing.gif differ
diff --git a/assets/chat_landing.gif b/assets/chat_landing.gif
new file mode 100644
index 00000000..18f138ab
Binary files /dev/null and b/assets/chat_landing.gif differ
diff --git a/assets/credits-models.gif b/assets/credits-models.gif
new file mode 100644
index 00000000..d020b706
Binary files /dev/null and b/assets/credits-models.gif differ
diff --git a/assets/editFile-diff-implementation.gif b/assets/editFile-diff-implementation.gif
new file mode 100644
index 00000000..0b6ce0d6
Binary files /dev/null and b/assets/editFile-diff-implementation.gif differ
diff --git a/assets/explain-tool-execution.gif b/assets/explain-tool-execution.gif
new file mode 100644
index 00000000..acbf1d5d
Binary files /dev/null and b/assets/explain-tool-execution.gif differ
diff --git a/assets/local-models-modal.png b/assets/local-models-modal.png
new file mode 100644
index 00000000..d3d8a279
Binary files /dev/null and b/assets/local-models-modal.png differ
diff --git a/docs/codegpt_plus_api.md b/docs/codegpt_plus_api.md
new file mode 100644
index 00000000..6cd00d13
--- /dev/null
+++ b/docs/codegpt_plus_api.md
@@ -0,0 +1,13 @@
+---
+sidebar_position: 6
+---
+
+# š CodeGPT Plus API
+Unleash the power of our AI Agents in your own applications with the CodeGPT Plus API. This API provides a gateway to harness the intelligence of CodeGPT Plus AI Agents, enabling you to integrate their capabilities into any application, regardless of the programming language you use.
+
+Whether you're building a chatbot, a virtual assistant, or any application that requires understanding and generating human-like text, the CodeGPT Plus API is your key to unlocking a new level of interactivity.
+
+Our API is RESTful, ensuring broad compatibility and easy integration across platforms. We also offer SDKs in Python and JavaScript, allowing you to implement our AI Agents in your preferred language.
+
+### Ready to revolutionize your development process?
+Visit our [CodeGPT Developer Hub](https://developers.codegpt.co/) to learn how you can integrate our AI Agents into your applications. The future of coding is at your fingertips, waiting to be explored.
diff --git a/docs/cookbook/_category_.json b/docs/cookbook/_category_.json
new file mode 100644
index 00000000..c9b223f1
--- /dev/null
+++ b/docs/cookbook/_category_.json
@@ -0,0 +1,8 @@
+{
+ "label": "š“ Cookbook",
+ "position": 5,
+
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/cookbook/generate_unit_test.md b/docs/cookbook/generate_unit_test.md
new file mode 100644
index 00000000..67cbb215
--- /dev/null
+++ b/docs/cookbook/generate_unit_test.md
@@ -0,0 +1,84 @@
+---
+sidebar_position: 1
+---
+# Writing Unit Tests
+
+CodeGPT can help you write unit tests for your Python code to ensure its functionality is reliable and bug-free.
+
+When developing Python applications, it's crucial to test individual components of your code. CodeGPT can assist by generating unit tests, suggesting edge cases, and ensuring your functions behave as expected under various conditions.
+
+### Example Scenario
+
+Suppose you have a Python function that calculates the total cost of items in a shopping cart, as shown below:
+
+```python
+def calculate_item_cost(item):
+ """Calculate the cost of a single item, considering discounts."""
+ discount = item.get('discount', 0)
+ return item['price'] * item['quantity'] * (1 - discount)
+
+def calculate_total(cart):
+ """Calculate the total cost of all items in the cart."""
+ return sum(calculate_item_cost(item) for item in cart)
+```
+
+You want to test this code using the `unittest` module.
+
+---
+
+### Example Prompt
+
+`How can I write unit tests to verify the correctness of these functions?`
+
+---
+
+### Example Response
+
+CodeGPT Chat might generate the following test suite:
+
+```python
+import unittest
+
+class TestShoppingCart(unittest.TestCase):
+
+ def test_calculate_item_cost_no_discount(self):
+ """Test item cost calculation without a discount."""
+ item = {'price': 10, 'quantity': 2}
+ self.assertEqual(calculate_item_cost(item), 20)
+
+ def test_calculate_item_cost_with_discount(self):
+ """Test item cost calculation with a discount."""
+ item = {'price': 50, 'quantity': 1, 'discount': 0.2}
+ self.assertEqual(calculate_item_cost(item), 40)
+
+ def test_calculate_total_no_items(self):
+ """Test total calculation for an empty cart."""
+ cart = []
+ self.assertEqual(calculate_total(cart), 0)
+
+ def test_calculate_total_multiple_items(self):
+ """Test total calculation for a cart with multiple items."""
+ cart = [
+ {'price': 10, 'quantity': 2, 'discount': 0.1},
+ {'price': 20, 'quantity': 1, 'discount': 0},
+ ]
+ self.assertEqual(calculate_total(cart), 38) # 18 + 20
+
+ def test_calculate_item_cost_invalid_item(self):
+ """Test behavior when the item dictionary is incomplete."""
+ item = {'price': 10} # Missing 'quantity'
+ with self.assertRaises(KeyError):
+ calculate_item_cost(item)
+
+if __name__ == '__main__':
+ unittest.main()
+```
+
+---
+
+### Explanation of Tests
+
+1. **Basic Functionality**: The first two tests ensure `calculate_item_cost` handles items with and without discounts correctly.
+2. **Empty Input**: The third test confirms `calculate_total` correctly handles an empty shopping cart.
+3. **Multiple Items**: The fourth test verifies the total cost calculation for multiple items in the cart.
+4. **Error Handling**: The fifth test checks how `calculate_item_cost` behaves when essential keys are missing from the input.
\ No newline at end of file
diff --git a/docs/cookbook/handling_api_errors.md b/docs/cookbook/handling_api_errors.md
new file mode 100644
index 00000000..041d68e6
--- /dev/null
+++ b/docs/cookbook/handling_api_errors.md
@@ -0,0 +1,87 @@
+---
+sidebar_position: 4
+---
+# Handling API Errors
+
+CodeGPT can help you analyze and improve how your application handles API errors by providing better error-handling strategies and examples.
+
+---
+
+### **Example Scenario**
+
+Suppose you're developing an application that consumes an API to fetch weather data. Occasionally, the API response fails due to network issues, invalid requests, or server errors. Hereās an example of the JSON error response from the API:
+
+```json
+{
+ "error": {
+ "code": 404,
+ "message": "City not found"
+ }
+}
+```
+
+Your current error-handling logic is minimal, and you want to improve it to handle different types of errors more effectively.
+
+---
+
+### **Example Prompt**
+
+**`How can I handle API errors more effectively when receiving responses like this one?`**
+
+---
+
+### **Example Response**
+
+CodeGPT might suggest the following enhanced error-handling strategy:
+
+1. **Check for Common Error Codes**: Use the `code` field in the error response to determine the type of error.
+2. **Provide User-Friendly Messages**: Translate error messages into language that end users can understand.
+3. **Implement Retry Logic**: For transient issues (e.g., network errors), retry the request with exponential backoff.
+
+Hereās an example of how your applicationās error-handling logic might look after improvements:
+
+---
+
+### **Improved Error Handling Logic**
+
+```python
+def handle_api_error(response):
+ """Handle errors from the weather API."""
+ error_code = response.get('error', {}).get('code')
+ error_message = response.get('error', {}).get('message')
+
+ if error_code == 404:
+ print("Error: The requested city was not found. Please check the city name and try again.")
+ elif error_code == 500:
+ print("Error: The server encountered an issue. Please try again later.")
+ elif error_code == 403:
+ print("Error: Access denied. Check your API key or permissions.")
+ else:
+ print(f"An unknown error occurred: {error_message or 'No details provided'}")
+
+# Example Usage
+api_response = {
+ "error": {
+ "code": 404,
+ "message": "City not found"
+ }
+}
+
+handle_api_error(api_response)
+```
+
+---
+
+### **Why This Matters**
+
+1. **Resilience**: Your application can respond gracefully to API failures without crashing.
+2. **User Experience**: Clear, actionable error messages help users resolve issues quickly.
+3. **Scalability**: By centralizing error handling, you can easily adapt to new API error types or codes.
+
+---
+
+### **Benefits of Using CodeGPT**
+
+- **Error Insights**: CodeGPT can help you understand complex error responses and suggest ways to handle them effectively.
+- **Customization**: Provides tailored suggestions based on the specific API or error scenarios youāre dealing with.
+- **Efficiency**: Saves time by automating the creation of robust error-handling strategies.
\ No newline at end of file
diff --git a/docs/cookbook/json_format.md b/docs/cookbook/json_format.md
new file mode 100644
index 00000000..76ba7815
--- /dev/null
+++ b/docs/cookbook/json_format.md
@@ -0,0 +1,79 @@
+---
+sidebar_position: 2
+---
+# Validating JSON Format
+
+CodeGPT can help you identify and correct formatting errors in JSON data, ensuring it is valid and parsable.
+
+---
+
+### **Example Scenario**
+
+Imagine you're working with an API that consumes JSON data. Your application throws the following error:
+
+```
+Error: Parse error
+-------------------^
+Expecting 'STRING', 'NUMBER', 'NULL', 'TRUE', 'FALSE', '{', '[', got 'undefined'
+```
+
+The JSON object causing the error looks like this:
+
+```json
+{
+ "user": {
+ "id": 123,
+ "name": "Jane Doe"
+ "email": "jane.doe@example.com",
+ "active": true,
+ },
+ "roles": [
+ "admin",
+ "editor",
+ "viewer",
+ ]
+}
+```
+
+---
+
+### **Example Prompt**
+
+**`Why is my JSON object invalid and how can I fix it?`**
+
+---
+
+### **Example Response**
+
+CodeGPT might respond with the following explanation and corrected JSON:
+
+**Explanation**:
+- The first issue is a missing comma after `"name": "Jane Doe"`.
+- The second issue is an extra trailing comma after the last element in the `roles` array.
+- Finally, there is a trailing comma after the `"active": true` key-value pair, which is not allowed in JSON.
+
+Here is the corrected JSON:
+
+```json
+{
+ "user": {
+ "id": 123,
+ "name": "Jane Doe",
+ "email": "jane.doe@example.com",
+ "active": true
+ },
+ "roles": [
+ "admin",
+ "editor",
+ "viewer"
+ ]
+}
+```
+
+---
+
+### **Benefits of Using CodeGPT**
+
+- **Error Identification**: CodeGPT pinpoints the exact lines where errors occur, saving time during debugging.
+- **Automatic Suggestions**: It not only identifies issues but also suggests precise corrections, making JSON editing seamless.
+- **Prevention**: Ensures JSON data is error-free before integrating with APIs or other services.
\ No newline at end of file
diff --git a/docs/cookbook/refactoring_json.md b/docs/cookbook/refactoring_json.md
new file mode 100644
index 00000000..8a823566
--- /dev/null
+++ b/docs/cookbook/refactoring_json.md
@@ -0,0 +1,85 @@
+---
+sidebar_position: 3
+---
+# Refactoring JSON
+
+CodeGPT can help you refactor JSON data to improve its structure and readability, making it easier to understand and maintain.
+
+---
+
+### **Example Scenario**
+
+Suppose you have a large JSON object that stores user data and their associated tasks. The current structure is functional but difficult to read and maintain:
+
+```json
+{
+ "users": [
+ {
+ "id": 1,
+ "name": "John Doe",
+ "tasks": [
+ {"taskId": 101, "description": "Complete project report", "status": "done"},
+ {"taskId": 102, "description": "Review team feedback", "status": "pending"}
+ ]
+ },
+ {
+ "id": 2,
+ "name": "Jane Smith",
+ "tasks": [
+ {"taskId": 103, "description": "Prepare presentation slides", "status": "done"},
+ {"taskId": 104, "description": "Organize team meeting", "status": "in progress"}
+ ]
+ }
+ ]
+}
+```
+
+You want to refactor this JSON to separate users and tasks into distinct entities for better organization.
+
+---
+
+### **Example Prompt**
+
+**`Can you refactor this JSON to separate users and tasks into separate entities for better readability?`**
+
+---
+
+### **Example Response**
+
+CodeGPT might provide the following refactored JSON structure:
+
+```json
+{
+ "users": [
+ {"id": 1, "name": "John Doe"},
+ {"id": 2, "name": "Jane Smith"}
+ ],
+ "tasks": [
+ {"taskId": 101, "userId": 1, "description": "Complete project report", "status": "done"},
+ {"taskId": 102, "userId": 1, "description": "Review team feedback", "status": "pending"},
+ {"taskId": 103, "userId": 2, "description": "Prepare presentation slides", "status": "done"},
+ {"taskId": 104, "userId": 2, "description": "Organize team meeting", "status": "in progress"}
+ ]
+}
+```
+
+---
+
+### **Explanation**
+
+1. **Separation of Concerns**:
+ - Users and tasks are now stored in separate arrays, making it easier to query and update either entity without affecting the other.
+
+2. **Linking Entities**:
+ - Each task now includes a `userId` field to indicate which user it belongs to, maintaining the relationship between users and tasks.
+
+3. **Improved Readability**:
+ - The data structure is cleaner, more modular, and easier to understand at a glance.
+
+---
+
+### **Benefits of Refactoring JSON**
+
+- **Scalability**: Separating entities simplifies future extensions, like adding new fields to users or tasks.
+- **Efficiency**: Searching, filtering, or modifying specific parts of the JSON becomes faster and more intuitive.
+- **Readability**: Easier for developers and collaborators to understand and maintain.
\ No newline at end of file
diff --git a/docs/cookbook/refactoring_legacy_code.md b/docs/cookbook/refactoring_legacy_code.md
new file mode 100644
index 00000000..c5c56af7
--- /dev/null
+++ b/docs/cookbook/refactoring_legacy_code.md
@@ -0,0 +1,62 @@
+---
+sidebar_position: 5
+---
+# Refactoring Legacy Code
+
+CodeGPT can assist you in refactoring legacy code to improve readability, maintainability, and performance while preserving functionality.
+
+---
+
+### **Example Scenario**
+
+Imagine you have a legacy Python function that calculates the factorial of a number. The original code is functional but inefficient and difficult to read:
+
+```python
+def factorial(n):
+ if n == 1:
+ return 1
+ else:
+ result = n
+ while n > 1:
+ n -= 1
+ result *= n
+ return result
+```
+
+You want to refactor this code to make it more concise and Pythonic.
+
+---
+
+### **Example Prompt**
+
+**`Can you help me refactor this factorial function for better readability and efficiency?`**
+
+---
+
+### **Example Response**
+
+CodeGPT might provide the following refactored version of the function:
+
+```python
+def factorial(n):
+ """Calculate the factorial of a number recursively."""
+ if n < 1:
+ raise ValueError("Input must be a positive integer.")
+ return 1 if n == 1 else n * factorial(n - 1)
+```
+
+---
+
+### **Benefits of the Refactor**
+
+1. **Improved Readability**: The code is concise and easier to understand at a glance.
+2. **Error Handling**: The refactored function includes a check to ensure the input is a positive integer.
+3. **Scalability**: The recursive approach is standard and aligns with mathematical definitions.
+
+---
+
+### **How CodeGPT Helps**
+
+- **Identifies Inefficiencies**: Suggests ways to simplify loops and redundant code.
+- **Adds Documentation**: Improves clarity by adding comments and docstrings.
+- **Enhances Performance**: Recommends algorithms and patterns that are optimized for the task.
\ No newline at end of file
diff --git a/docs/intro.md b/docs/intro.md
index 240de3a4..14c77333 100644
--- a/docs/intro.md
+++ b/docs/intro.md
@@ -1,35 +1,33 @@
---
sidebar_position: 1
+keywords: [introduction, welcome, getting started, codegpt, ai, coding, productivity, workflow, insights, visual studio code, jetbrains, ide, extension, features, benefits, revolutionize, coding experience, seasoned developer, starting out, productivity, streamline, insights, development environment, range of features, empower, coding journey]
---
-# Intro
+# š Welcome
- This tutorial will teach you how to use the extension and we will also show you tips so that you can get the most out of all the extension's features.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
{siteConfig.tagline}
+