Skip to content

Commit

Permalink
Remove Company Codebase for now, minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
avishagQodo committed Nov 24, 2024
1 parent 8ac1928 commit 3c1e290
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/chat/add-context.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Different context options include:
You can add an image as a context to your request. [Read more about adding images to the chat.](./images.md)

6. **Add Company Codebase**
You can add entire folders and files from your company's codebase as extra context, making your experience more relevant and tailored to your specific needs. [Read more about adding images to the chat.](./company-codebase.md)
You can add entire folders and files from your company's codebase as extra context, making your experience more relevant and tailored to your specific needs. Read more about adding images to the chat.

!!! alert "Please Notice"
In JetBrains, you can index up to 1,000 files in a single folder or project.
Expand Down
2 changes: 1 addition & 1 deletion docs/chat/commands/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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!

## The `best_practices.md` File

Expand Down
14 changes: 11 additions & 3 deletions docs/chat/company-codebase.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
---
<!-- ---
title: Company Codebase
status: new
---
# :fontawesome-solid-file-code: Company Codebase
הסבר כללי על מה זה אומר, דוגמאות לאיך אפשר להשתמש בפיצ'ר הזה
context awareness, לשאול את אילנה
לתת דוגמאות לשאלות מעניינות שאפשר לשאול את הראג וכו. איפה כדאי להשתמש בו ואיפה לא?
היוזר יכול לשאול שאלות שהן חוצות ריפוזיטוריז
הצ'אט מחובר לכל הקודבייס של החברה
בהמשך: פילטרים פר קודבייס, פר פרונטאנד/בקאנד/שפה...
## Overview
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.
Expand All @@ -21,7 +29,7 @@ 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. -->

![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
Expand All @@ -32,4 +40,4 @@ To start using Company Codebase:
## Example Usage
* **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. --> -->
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand Down

0 comments on commit 3c1e290

Please sign in to comment.