Merge pull request #27 from Codium-ai/docs/add-company-codebase

Update Company Codebase

docs/chat/commands/best-practices.md

@@ -19,7 +19,7 @@ To use the `/generate-best-practices` command, follow these steps:
 
 3. **Copy the Response as Markdown**: Click the three dots button in the top-right corner of Qodo Gen's response message, and select `Copy message as markdown`. Paste the markdown content into a new file named `best_practices.md`.
 
-4. **Customize `best_practices.md`**: Modify the content of `best_practices.md` as needed. You can add new best practices, modify existing ones, or remove parts to better suit your team's requirements. You can also ask Qodo Chat to do that for you!
+4. **Customize `best_practices.md`**: Modify the content of `best_practices.md` as needed. You can add new best practices, modify existing ones, or remove parts to better suit your team's requirements. You can also ask Qodo Gen Chat to do that for you!
 
 ## The `best_practices.md` File
 

docs/chat/company-codebase.md

@@ -1,43 +1,51 @@
-<!-- ---
+---
 title: Company Codebase
 status: new
 ---
 
 # :fontawesome-solid-file-code: Company Codebase
 
-הסבר כללי על מה זה אומר, דוגמאות לאיך אפשר להשתמש בפיצ'ר הזה
-context awareness, לשאול את אילנה
-לתת דוגמאות לשאלות מעניינות שאפשר לשאול את הראג וכו. איפה כדאי להשתמש בו ואיפה לא?
-היוזר יכול לשאול שאלות שהן חוצות ריפוזיטוריז
-הצ'אט מחובר לכל הקודבייס של החברה
-בהמשך: פילטרים פר קודבייס, פר פרונטאנד/בקאנד/שפה...
+## What is Company Codebase?
+
+Company Codebase helps Qodo Gen Chat to know your codebase better, enabling you to ask complex, code-specific questions and get better answers.
 
+For example, with Company Codebase you can ask Qodo Gen Chat **"How do I use our auth service to set up authentication for my new app?"** and get the right response.
 
-## Overview
+## How does Company Codebase work?
 
-Retrieval-Augmented Generation (RAG) is a technique that combines retrieval-based methods with generative models to enhance the quality and relevance of generated content. Qodo Gen uses RAG to better understand your company's codebase.
+Retrieval-Augmented Generation (RAG) is a technique that combines retrieval-based methods with generative models to enhance the quality and relevance of generated content.
 
-By leveraging your company's codebase, Qodo Gen gains deeper context about your projects, making your experience more relevant and tailored to your specific needs.
+Qodo Gen uses RAG to understand your company's codebase better, gain deeper context about your projects and answer more complicated or specific questions.
 
 !!! pro "Pro feature"
     This feature is available for Enterprise users only.
 
-<!-- ## Using Company Codebase
+## Using Company Codebase
 
 To start using Company Codebase:
 
-1. **Install the Github App**: 
-2. **Select Repositories**: Select the repositories you'd like to use as context. Read more on this page to learn more about indexing strategy. -->
+1. **Open Qodo Gen Chat:** From your extensions bar, choose the Qodo logo to open Qodo Gen Chat.
+2. **Choose Extra Context:** Click on the `Extra Context` button located under the chatbox.
+3. **Select Company Codebase:** From the dropdown menu, select `Company Codebase`.
 
-<!-- ![Company's Codebase](https://www.qodo.ai/images/codiumate/companys-codebase.png){width=700, loading=lazy}
+![Company's Codebase](https://www.qodo.ai/images/codiumate/companys-codebase.png){width=700, loading=lazy}
 
-## Indexing Strategy
+## What can you do with Company Codebase? 
 
-* **Focus on Specific Contexts:** Index folders or files relevant to your task (e.g., src, code completions). Avoid indexing the entire project.
-* **Examples Folder:** Create an examples folder and add it to the context. This can be used to store good examples and improve the quality of responses.
-* **External Code:** If you are using a new or undocumented API, create an "External code" folder in your project and add the source code there. This can be indexed to provide context for your questions and improve the answers dramatically.
+Using Company Codebase in Qodo Gen Chat, you can get answers to deeper, more complicated questions.
 
-## Example Usage 
+**For Example, you can try asking:**
 
+* "Where in our codebase do we have a function with similar functionality to this one?"
+* "How do I use our auth service to set up authentication for my new app?"
+* "What are the best practices for using our logging library?"
+* "How do I integrate our new API into this project?"
 * **Template Generation:** Use RAG to generate templates for common tasks, such as creating a Kotlin class with logging. This can help standardize code across your project.
-* **Avoiding Code Duplication:** Use RAG to check for code duplication by selecting the context of the current file and asking relevant questions. --> -->
+* **Avoiding Code Duplication:** Use RAG to check for code duplication by selecting the context of the current file and asking relevant questions.
+
+
+<!-- ## Indexing Strategy
+
+* **Focus on Specific Contexts:** Index folders or files relevant to your task (e.g., src, code completions). Avoid indexing the entire project.
+* **Examples Folder:** Create an examples folder and add it to the context. This can be used to store good examples and improve the quality of responses.
+* **External Code:** If you are using a new or undocumented API, create an "External code" folder in your project and add the source code there. This can be indexed to provide context for your questions and improve the answers dramatically. -->

mkdocs.yml

@@ -48,7 +48,7 @@ nav:
     - Coding-Agent: 'chat/coding-agent.md'
     - Chat History: 'chat/chat-history.md'
     - Model Selection: 'chat/model-selection.md'
-    # - Company Codebade: 'chat/company-codebase.md'
+    - Company Codebade: 'chat/company-codebase.md'
   - Code Completion:
     - 'code-completion/index.md'