diff --git a/docs/README.md b/docs/README.md index 42154c966..961eb1f06 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1 @@ -# [Visit Our Docs Portal](https://pr-agent-docs.codium.ai/) +# [Visit Our Docs Portal](https://qodo-merge-docs.qodo.ai/) diff --git a/docs/docs/chrome-extension/data_privacy.md b/docs/docs/chrome-extension/data_privacy.md index 37052e25d..14753a0c6 100644 --- a/docs/docs/chrome-extension/data_privacy.md +++ b/docs/docs/chrome-extension/data_privacy.md @@ -1,5 +1,5 @@ We take your code's security and privacy seriously: - The Chrome extension will not send your code to any external servers. -- For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing PR-Agent Pro integration. +- For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing Qodo Merge Pro integration. diff --git a/docs/docs/chrome-extension/features.md b/docs/docs/chrome-extension/features.md index 3db586577..7edcbed11 100644 --- a/docs/docs/chrome-extension/features.md +++ b/docs/docs/chrome-extension/features.md @@ -4,22 +4,22 @@ The PR-Chat feature allows to freely chat with your PR code, within your GitHub environment. It will seamlessly use the PR as context to your chat session, and provide AI-powered feedback. -To enable private chat, simply install the PR-Agent Chrome extension. After installation, each PR's file-changed tab will include a chat box, where you may ask questions about your code. +To enable private chat, simply install the Qodo Merge Chrome extension. After installation, each PR's file-changed tab will include a chat box, where you may ask questions about your code. This chat session is **private**, and won't be visible to other users. All open-source repositories are supported. -For private repositories, you will also need to install PR-Agent Pro, After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories. +For private repositories, you will also need to install Qodo Merge Pro, After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories. #### Context-aware PR chat -PR-Agent constructs a comprehensive context for each pull request, incorporating the PR description, commit messages, and code changes with extended dynamic context. This contextual information, along with additional PR-related data, forms the foundation for an AI-powered chat session. The agent then leverages this rich context to provide intelligent, tailored responses to user inquiries about the pull request. +Qodo Merge constructs a comprehensive context for each pull request, incorporating the PR description, commit messages, and code changes with extended dynamic context. This contextual information, along with additional PR-related data, forms the foundation for an AI-powered chat session. The agent then leverages this rich context to provide intelligent, tailored responses to user inquiries about the pull request. ### Toolbar extension -With PR-Agent Chrome extension, it's [easier than ever](https://www.youtube.com/watch?v=gT5tli7X4H4) to interactively configure and experiment with the different tools and configuration options. +With Qodo Merge Chrome extension, it's [easier than ever](https://www.youtube.com/watch?v=gT5tli7X4H4) to interactively configure and experiment with the different tools and configuration options. For private repositories, after you found the setup that works for you, you can also easily export it as a persistent configuration file, and use it for automatic commands. @@ -27,11 +27,11 @@ For private repositories, after you found the setup that works for you, you can -### PR-Agent filters +### Qodo Merge filters -PR-Agent filters is a sidepanel option. that allows you to filter different message in the conversation tab. +Qodo Merge filters is a sidepanel option. that allows you to filter different message in the conversation tab. -For example, you can choose to present only message from PR-Agent, or filter those messages, focusing only on user's comments. +For example, you can choose to present only message from Qodo Merge, or filter those messages, focusing only on user's comments. @@ -40,7 +40,7 @@ For example, you can choose to present only message from PR-Agent, or filter tho ### Enhanced code suggestions -PR-Agent Chrome extension adds the following capabilities to code suggestions tool's comments: +Qodo Merge Chrome extension adds the following capabilities to code suggestions tool's comments: - Auto-expand the table when you are viewing a code block, to avoid clipping. - Adding a "quote-and-reply" button, that enables to address and comment on a specific suggestion (for example, asking the author to fix the issue) diff --git a/docs/docs/chrome-extension/index.md b/docs/docs/chrome-extension/index.md index 1261f5ae1..6885df4b5 100644 --- a/docs/docs/chrome-extension/index.md +++ b/docs/docs/chrome-extension/index.md @@ -1,11 +1,11 @@ -[PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) is a collection of tools that integrates seamlessly with your GitHub environment, aiming to enhance your Git usage experience, and providing AI-powered capabilities to your PRs. +[Qodo Merge Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) is a collection of tools that integrates seamlessly with your GitHub environment, aiming to enhance your Git usage experience, and providing AI-powered capabilities to your PRs. -With a single-click installation you will gain access to a context-aware chat on your pull requests code, a toolbar extension with multiple AI feedbacks, PR-Agent filters, and additional abilities. +With a single-click installation you will gain access to a context-aware chat on your pull requests code, a toolbar extension with multiple AI feedbacks, Qodo Merge filters, and additional abilities. The extension is powered by top code models like Claude 3.5 Sonnet and GPT4. All the extension's features are free to use on public repositories. -For private repositories, you will need to install [PR-Agent Pro](https://github.com/apps/codiumai-pr-agent-pro) in addition to the extension (Quick GitHub app setup with a 14-day free trial. No credit card needed). -For a demonstration of how to install PR-Agent Pro and use it with the Chrome extension, please refer to the tutorial video at the provided [link](https://codium.ai/images/pr_agent/private_repos.mp4). +For private repositories, you will need to install [Qodo Merge Pro](https://github.com/apps/codiumai-pr-agent-pro) in addition to the extension (Quick GitHub app setup with a 14-day free trial. No credit card needed). +For a demonstration of how to install Qodo Merge Pro and use it with the Chrome extension, please refer to the tutorial video at the provided [link](https://codium.ai/images/pr_agent/private_repos.mp4). diff --git a/docs/docs/core-abilities/dynamic_context.md b/docs/docs/core-abilities/dynamic_context.md index 7f07d222a..b8b71a30d 100644 --- a/docs/docs/core-abilities/dynamic_context.md +++ b/docs/docs/core-abilities/dynamic_context.md @@ -1,6 +1,6 @@ ## TL;DR -PR-Agent uses an **asymmetric and dynamic context strategy** to improve AI analysis of code changes in pull requests. +Qodo Merge uses an **asymmetric and dynamic context strategy** to improve AI analysis of code changes in pull requests. It provides more context before changes than after, and dynamically adjusts the context based on code structure (e.g., enclosing functions or classes). This approach balances providing sufficient context for accurate analysis, while avoiding needle-in-the-haystack information overload that could degrade AI performance or exceed token limits. @@ -43,14 +43,14 @@ Pull requests often encompass multiple changes across many files, potentially sp - Increased context expands the token count, increasing processing time and cost, and may prevent the model from processing the entire pull request in a single pass. ## Asymmetric and dynamic context -To address these challenges, PR-Agent employs an **asymmetric** and **dynamic** context strategy, providing the model with more focused and relevant context information for each code change. +To address these challenges, Qodo Merge employs an **asymmetric** and **dynamic** context strategy, providing the model with more focused and relevant context information for each code change. **Asymmetric:** We start by recognizing that the context preceding a code change is typically more crucial for understanding the modification than the context following it. -Consequently, PR-Agent implements an asymmetric context policy, decoupling the context window into two distinct segments: one for the code before the change and another for the code after. +Consequently, Qodo Merge implements an asymmetric context policy, decoupling the context window into two distinct segments: one for the code before the change and another for the code after. -By independently adjusting each context window, PR-Agent can supply the model with a more tailored and pertinent context for individual code changes. +By independently adjusting each context window, Qodo Merge can supply the model with a more tailored and pertinent context for individual code changes. **Dynamic:** diff --git a/docs/docs/core-abilities/impact_evaluation.md b/docs/docs/core-abilities/impact_evaluation.md index 327482f68..41db3b527 100644 --- a/docs/docs/core-abilities/impact_evaluation.md +++ b/docs/docs/core-abilities/impact_evaluation.md @@ -1,43 +1,43 @@ # Overview - Impact Evaluation ๐Ÿ’Ž Demonstrating the return on investment (ROI) of AI-powered initiatives is crucial for modern organizations. -To address this need, PR-Agent has developed an AI impact measurement tools and metrics, providing advanced analytics to help businesses quantify the tangible benefits of AI adoption in their PR review process. +To address this need, Qodo Merge has developed an AI impact measurement tools and metrics, providing advanced analytics to help businesses quantify the tangible benefits of AI adoption in their PR review process. -## Auto Impact Validator - Real-Time Tracking of Implemented PR-Agent Suggestions +## Auto Impact Validator - Real-Time Tracking of Implemented Qodo Merge Suggestions ### How It Works -When a user pushes a new commit to the pull request, PR-Agent automatically compares the updated code against the previous suggestions, marking them as implemented if the changes address these recommendations, whether directly or indirectly: +When a user pushes a new commit to the pull request, Qodo Merge automatically compares the updated code against the previous suggestions, marking them as implemented if the changes address these recommendations, whether directly or indirectly: 1. **Direct Implementation:** The user directly addresses the suggestion as-is in the PR, either by clicking on the "apply code suggestion" checkbox or by making the changes manually. -2. **Indirect Implementation:** PR-Agent recognizes when a suggestion's intent is fulfilled, even if the exact code changes differ from the original recommendation. It marks these suggestions as implemented, acknowledging that users may achieve the same goal through alternative solutions. +2. **Indirect Implementation:** Qodo Merge recognizes when a suggestion's intent is fulfilled, even if the exact code changes differ from the original recommendation. It marks these suggestions as implemented, acknowledging that users may achieve the same goal through alternative solutions. ### Real-Time Visual Feedback -Upon confirming that a suggestion was implemented, PR-Agent automatically adds a โœ… (check mark) to the relevant suggestion, enabling transparent tracking of PR-Agent's impact analysis. -PR-Agent will also add, inside the relevant suggestions, an explanation of how the new code was impacted by each suggestion. +Upon confirming that a suggestion was implemented, Qodo Merge automatically adds a โœ… (check mark) to the relevant suggestion, enabling transparent tracking of Qodo Merge's impact analysis. +Qodo Merge will also add, inside the relevant suggestions, an explanation of how the new code was impacted by each suggestion. ![Suggestion_checkmark](https://codium.ai/images/pr_agent/auto_suggestion_checkmark.png){width=512} ### Dashboard Metrics -The dashboard provides macro-level insights into the overall impact of PR-Agent on the pull-request process with key productivity metrics. +The dashboard provides macro-level insights into the overall impact of Qodo Merge on the pull-request process with key productivity metrics. -By offering clear, data-driven evidence of PR-Agent's impact, it empowers leadership teams to make informed decisions about the tool's effectiveness and ROI. +By offering clear, data-driven evidence of Qodo Merge's impact, it empowers leadership teams to make informed decisions about the tool's effectiveness and ROI. Here are key metrics that the dashboard tracks: -#### PR-Agent Impacts per 1K Lines +#### Qodo Merge Impacts per 1K Lines ![Dashboard](https://codium.ai/images/pr_agent/impacts_per_1k_llines.png){width=512} -> Explanation: for every 1K lines of code (additions/edits), PR-Agent had on average ~X suggestions implemented. +> Explanation: for every 1K lines of code (additions/edits), Qodo Merge had on average ~X suggestions implemented. **Why This Metric Matters:** -1. **Standardized and Comparable Measurement:** By measuring impacts per 1K lines of code additions, you create a standardized metric that can be compared across different projects, teams, customers, and time periods. This standardization is crucial for meaningful analysis, benchmarking, and identifying where PR-Agent is most effective. +1. **Standardized and Comparable Measurement:** By measuring impacts per 1K lines of code additions, you create a standardized metric that can be compared across different projects, teams, customers, and time periods. This standardization is crucial for meaningful analysis, benchmarking, and identifying where Qodo Merge is most effective. 2. **Accounts for PR Variability and Incentivizes Quality:** This metric addresses the fact that "Not all PRs are created equal." By normalizing against lines of code rather than PR count, you account for the variability in PR sizes and focus on the quality and impact of suggestions rather than just the number of PRs affected. -3. **Quantifies Value and ROI:** The metric directly correlates with the value PR-Agent is providing, showing how frequently it offers improvements relative to the amount of new code being written. This provides a clear, quantifiable way to demonstrate PR-Agent's return on investment to stakeholders. +3. **Quantifies Value and ROI:** The metric directly correlates with the value Qodo Merge is providing, showing how frequently it offers improvements relative to the amount of new code being written. This provides a clear, quantifiable way to demonstrate Qodo Merge's return on investment to stakeholders. #### Suggestion Effectiveness Across Categories ![Impacted_Suggestion_Score](https://codium.ai/images/pr_agent/impact_by_category.png){width=512} -> Explanation: This chart illustrates the distribution of implemented suggestions across different categories, enabling teams to better understand PR-Agent's impact on various aspects of code quality and development practices. +> Explanation: This chart illustrates the distribution of implemented suggestions across different categories, enabling teams to better understand Qodo Merge's impact on various aspects of code quality and development practices. #### Suggestion Score Distribution ![Impacted_Suggestion_Score](https://codium.ai/images/pr_agent/impacted_score_dist.png){width=512} diff --git a/docs/docs/core-abilities/index.md b/docs/docs/core-abilities/index.md index 7d9831449..aac016ee9 100644 --- a/docs/docs/core-abilities/index.md +++ b/docs/docs/core-abilities/index.md @@ -1,12 +1,12 @@ # Core Abilities -PR-Agent utilizes a variety of core abilities to provide a comprehensive and efficient code review experience. These abilities include: +Qodo Merge utilizes a variety of core abilities to provide a comprehensive and efficient code review experience. These abilities include: -- [Local and global metadata](https://pr-agent-docs.codium.ai/core-abilities/metadata/) -- [Dynamic context](https://pr-agent-docs.codium.ai/core-abilities/dynamic_context/) -- [Self-reflection](https://pr-agent-docs.codium.ai/core-abilities/self_reflection/) -- [Impact evaluation](https://pr-agent-docs.codium.ai/core-abilities/impact_evaluation/) -- [Interactivity](https://pr-agent-docs.codium.ai/core-abilities/interactivity/) -- [Compression strategy](https://pr-agent-docs.codium.ai/core-abilities/compression_strategy/) -- [Code-oriented YAML](https://pr-agent-docs.codium.ai/core-abilities/code_oriented_yaml/) -- [Static code analysis](https://pr-agent-docs.codium.ai/core-abilities/static_code_analysis/) -- [Code fine-tuning benchmark](https://pr-agent-docs.codium.ai/finetuning_benchmark/) \ No newline at end of file +- [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) +- [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) +- [Self-reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) +- [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) +- [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/) +- [Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) +- [Code-oriented YAML](https://qodo-merge-docs.qodo.ai/core-abilities/code_oriented_yaml/) +- [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) +- [Code fine-tuning benchmark](https://qodo-merge-docs.qodo.ai/finetuning_benchmark/) \ No newline at end of file diff --git a/docs/docs/core-abilities/metadata.md b/docs/docs/core-abilities/metadata.md index 2ad5609a1..b1dda1619 100644 --- a/docs/docs/core-abilities/metadata.md +++ b/docs/docs/core-abilities/metadata.md @@ -1,6 +1,6 @@ ## Local and global metadata injection with multi-stage analysis (1) -PR-Agent initially retrieves for each PR the following data: +Qodo Merge initially retrieves for each PR the following data: - PR title and branch name - PR original description @@ -9,10 +9,10 @@ PR-Agent initially retrieves for each PR the following data: - The entire content of the files that were modified in the PR !!! tip "Tip: Organization-level metadata" - In addition to the inputs above, PR-Agent can incorporate supplementary preferences provided by the user, like [`extra_instructions` and `organization best practices`](https://pr-agent-docs.codium.ai/tools/improve/#extra-instructions-and-best-practices). This information can be used to enhance the PR analysis. + In addition to the inputs above, Qodo Merge can incorporate supplementary preferences provided by the user, like [`extra_instructions` and `organization best practices`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices). This information can be used to enhance the PR analysis. (2) -By default, the first command that PR-Agent executes is [`describe`](https://pr-agent-docs.codium.ai/tools/describe/), which generates three types of outputs: +By default, the first command that Qodo Merge executes is [`describe`](https://qodo-merge-docs.qodo.ai/tools/describe/), which generates three types of outputs: - PR Type (e.g. bug fix, feature, refactor, etc) - PR Description - a bullet point summary of the PR @@ -21,7 +21,7 @@ By default, the first command that PR-Agent executes is [`describe`](https://pr- These AI-generated outputs are now considered as part of the PR metadata, and can be used in subsequent commands like `review` and `improve`. This effectively enables multi-stage chain-of-thought analysis, without doing any additional API calls which will cost time and money. -For example, when generating code suggestions for different files, PR-Agent can inject the AI-generated ["Changes walkthrough"](https://github.com/Codium-ai/pr-agent/pull/1202#issue-2511546839) file summary in the prompt: +For example, when generating code suggestions for different files, Qodo Merge can inject the AI-generated ["Changes walkthrough"](https://github.com/Codium-ai/pr-agent/pull/1202#issue-2511546839) file summary in the prompt: ``` ## File: 'src/file1.py' @@ -49,8 +49,8 @@ __old hunk__ ... ``` -(3) The entire PR files that were retrieved are also used to expand and enhance the PR context (see [Dynamic Context](https://pr-agent-docs.codium.ai/core-abilities/dynamic-context/)). +(3) The entire PR files that were retrieved are also used to expand and enhance the PR context (see [Dynamic Context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic-context/)). (4) All the metadata described above represents several level of cumulative analysis - ranging from hunk level, to file level, to PR level, to organization level. -This comprehensive approach enables PR-Agent AI models to generate more precise and contextually relevant suggestions and feedback. \ No newline at end of file +This comprehensive approach enables Qodo Merge AI models to generate more precise and contextually relevant suggestions and feedback. \ No newline at end of file diff --git a/docs/docs/core-abilities/self_reflection.md b/docs/docs/core-abilities/self_reflection.md index f58a730d8..b8acc3951 100644 --- a/docs/docs/core-abilities/self_reflection.md +++ b/docs/docs/core-abilities/self_reflection.md @@ -1,6 +1,6 @@ ## TL;DR -PR-Agent implements a **self-reflection** process where the AI model reflects, scores, and re-ranks its own suggestions, eliminating irrelevant or incorrect ones. +Qodo Merge implements a **self-reflection** process where the AI model reflects, scores, and re-ranks its own suggestions, eliminating irrelevant or incorrect ones. This approach improves the quality and relevance of suggestions, saving users time and enhancing their experience. Configuration options allow users to set a score threshold for further filtering out suggestions. @@ -9,7 +9,7 @@ Configuration options allow users to set a score threshold for further filtering Given that not all generated code suggestions will be relevant, it is crucial to enable users to review them in a fast and efficient way, allowing quick identification and filtering of non-applicable ones. -To achieve this goal, PR-Agent offers a dedicated hierarchical structure when presenting suggestions to users: +To achieve this goal, Qodo Merge offers a dedicated hierarchical structure when presenting suggestions to users: - A "category" section groups suggestions by their category, allowing users to quickly dismiss irrelevant suggestions. - Each suggestion is first described by a one-line summary, which can be expanded to a full description by clicking on a collapsible. @@ -34,7 +34,7 @@ This process consists of the following steps: Note that presenting all generated suggestions simultaneously provides the model with a comprehensive context, enabling it to make more informed decisions compared to evaluating each suggestion individually. -To conclude, the self-reflection process enables PR-Agent to prioritize suggestions based on their importance, eliminate inaccurate or irrelevant proposals, and optionally exclude suggestions that fall below a specified threshold of significance. +To conclude, the self-reflection process enables Qodo Merge to prioritize suggestions based on their importance, eliminate inaccurate or irrelevant proposals, and optionally exclude suggestions that fall below a specified threshold of significance. This results in a more refined and valuable set of suggestions for the user, saving time and improving the overall experience. ## Example Results diff --git a/docs/docs/core-abilities/static_code_analysis.md b/docs/docs/core-abilities/static_code_analysis.md index b33c2c5d0..823de0c7e 100644 --- a/docs/docs/core-abilities/static_code_analysis.md +++ b/docs/docs/core-abilities/static_code_analysis.md @@ -1,6 +1,6 @@ ## Overview - Static Code Analysis ๐Ÿ’Ž -By combining static code analysis with LLM capabilities, PR-Agent can provide a comprehensive analysis of the PR code changes on a component level. +By combining static code analysis with LLM capabilities, Qodo Merge can provide a comprehensive analysis of the PR code changes on a component level. It scans the PR code changes, finds all the code components (methods, functions, classes) that changed, and enables to interactively generate tests, docs, code suggestions and similar code search for each component. @@ -13,7 +13,7 @@ It scans the PR code changes, finds all the code components (methods, functions, ### Analyze PR -The [`analyze`](https://pr-agent-docs.codium.ai/tools/analyze/) tool enables to interactively generate tests, docs, code suggestions and similar code search for each component that changed in the PR. +The [`analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/) tool enables to interactively generate tests, docs, code suggestions and similar code search for each component that changed in the PR. It can be invoked manually by commenting on any PR: ``` /analyze @@ -27,7 +27,7 @@ Clicking on each checkbox will trigger the relevant tool for the selected compon ### Generate Tests -The [`test`](https://pr-agent-docs.codium.ai/tools/test/) tool generate tests for a selected component, based on the PR code changes. +The [`test`](https://qodo-merge-docs.qodo.ai/tools/test/) tool generate tests for a selected component, based on the PR code changes. It can be invoked manually by commenting on any PR: ``` /test component_name @@ -38,7 +38,7 @@ where 'component_name' is the name of a specific component in the PR, Or be tri ### Generate Docs for a Component -The [`add_docs`](https://pr-agent-docs.codium.ai/tools/documentation/) tool scans the PR code changes, and automatically generate docstrings for any code components that changed in the PR. +The [`add_docs`](https://qodo-merge-docs.qodo.ai/tools/documentation/) tool scans the PR code changes, and automatically generate docstrings for any code components that changed in the PR. It can be invoked manually by commenting on any PR: ``` /add_docs component_name @@ -49,7 +49,7 @@ Or be triggered interactively by using the `analyze` tool. ![Docs single component](https://codium.ai/images/pr_agent/docs_single_component.png){width=768} ### Generate Code Suggestions for a Component -The [`improve_component`](https://pr-agent-docs.codium.ai/tools/improve_component/) tool generates code suggestions for a specific code component that changed in the PR. +The [`improve_component`](https://qodo-merge-docs.qodo.ai/tools/improve_component/) tool generates code suggestions for a specific code component that changed in the PR. It can be invoked manually by commenting on any PR: ``` /improve_component component_name @@ -61,7 +61,7 @@ Or be triggered interactively by using the `analyze` tool. ### Find Similar Code -The [`similar code`](https://pr-agent-docs.codium.ai/tools/similar_code/) tool retrieves the most similar code components from inside the organization's codebase, or from open-source code. +The [`similar code`](https://qodo-merge-docs.qodo.ai/tools/similar_code/) tool retrieves the most similar code components from inside the organization's codebase, or from open-source code. For example: diff --git a/docs/docs/faq/index.md b/docs/docs/faq/index.md index 7536492e2..e01920b8e 100644 --- a/docs/docs/faq/index.md +++ b/docs/docs/faq/index.md @@ -1,14 +1,14 @@ # FAQ -??? note "Question: Can PR-Agent serve as a substitute for a human reviewer?" +??? note "Question: Can Qodo Merge serve as a substitute for a human reviewer?" #### Answer:1 - PR-Agent is designed to assist, not replace, human reviewers. + Qodo Merge is designed to assist, not replace, human reviewers. Reviewing PRs is a tedious and time-consuming task often seen as a "chore". In addition, the longer the PR โ€“ the shorter the relative feedback, since long PRs can overwhelm reviewers, both in terms of technical difficulty, and the actual review time. - PR-Agent aims to address these pain points, and to assist and empower both the PR author and reviewer. + Qodo Merge aims to address these pain points, and to assist and empower both the PR author and reviewer. - However, PR-Agent has built-in safeguards to ensure the developer remains in the driver's seat. For example: + However, Qodo Merge has built-in safeguards to ensure the developer remains in the driver's seat. For example: 1. Preserves user's original PR header 2. Places user's description above the AI-generated PR description @@ -35,33 +35,33 @@ ___ - Only if the `Category` header is relevant, the user should move to the summarized suggestion description. - Only if the summarized suggestion description is relevant, the user should click on the collapsible, to read the full suggestion description with a code preview example. - - In addition, we recommend to use the [`extra_instructions`](https://pr-agent-docs.codium.ai/tools/improve/#extra-instructions-and-best-practices) field to guide the model to suggestions that are more relevant to the specific needs of the project. - - The interactive [PR chat](https://pr-agent-docs.codium.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model. + - In addition, we recommend to use the [`extra_instructions`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) field to guide the model to suggestions that are more relevant to the specific needs of the project. + - The interactive [PR chat](https://qodo-merge-docs.qodo.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model. ___ ??? note "Question: How can I get more tailored suggestions?" #### Answer:3 - See [here](https://pr-agent-docs.codium.ai/tools/improve/#extra-instructions-and-best-practices) for more information on how to use the `extra_instructions` and `best_practices` configuration options, to guide the model to more tailored suggestions. + See [here](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) for more information on how to use the `extra_instructions` and `best_practices` configuration options, to guide the model to more tailored suggestions. ___ ??? note "Question: Will you store my code ? Are you using my code to train models?" #### Answer:4 - No. PR-Agent strict privacy policy ensures that your code is not stored or used for training purposes. + No. Qodo Merge strict privacy policy ensures that your code is not stored or used for training purposes. - For a detailed overview of our data privacy policy, please refer to [this link](https://pr-agent-docs.codium.ai/overview/data_privacy/) + For a detailed overview of our data privacy policy, please refer to [this link](https://qodo-merge-docs.qodo.ai/overview/data_privacy/) ___ -??? note "Question: Can I use my own LLM keys with PR-Agent?" +??? note "Question: Can I use my own LLM keys with Qodo Merge?" #### Answer:5 When you self-host, you use your own keys. - PR-Agent Pro with SaaS deployment is a hosted version of PR-Agent, where Codium AI manages the infrastructure and the keys. + Qodo Merge Pro with SaaS deployment is a hosted version of Qodo Merge, where Qodo manages the infrastructure and the keys. For enterprise customers, on-prem deployment is also available. [Contact us](https://www.codium.ai/contact/#pricing) for more information. ___ \ No newline at end of file diff --git a/docs/docs/finetuning_benchmark/index.md b/docs/docs/finetuning_benchmark/index.md index d487853b5..5a002df8d 100644 --- a/docs/docs/finetuning_benchmark/index.md +++ b/docs/docs/finetuning_benchmark/index.md @@ -1,10 +1,10 @@ -# PR-Agent Code Fine-tuning Benchmark +# Qodo Merge Code Fine-tuning Benchmark On coding tasks, the gap between open-source models and top closed-source models such as GPT4 is significant.
In practice, open-source models are unsuitable for most real-world code tasks, and require further fine-tuning to produce acceptable results. -_PR-Agent fine-tuning benchmark_ aims to benchmark open-source models on their ability to be fine-tuned for a coding task. +_Qodo Merge fine-tuning benchmark_ aims to benchmark open-source models on their ability to be fine-tuned for a coding task. Specifically, we chose to fine-tune open-source models on the task of analyzing a pull request, and providing useful feedback and code suggestions. Here are the results: @@ -53,8 +53,8 @@ Here are the results: ### Training dataset -Our training dataset comprises 25,000 pull requests, aggregated from permissive license repos. For each pull request, we generated responses for the three main tools of PR-Agent: -[Describe](https://pr-agent-docs.codium.ai/tools/describe/), [Review](https://pr-agent-docs.codium.ai/tools/improve/) and [Improve](https://pr-agent-docs.codium.ai/tools/improve/). +Our training dataset comprises 25,000 pull requests, aggregated from permissive license repos. For each pull request, we generated responses for the three main tools of Qodo Merge: +[Describe](https://qodo-merge-docs.qodo.ai/tools/describe/), [Review](https://qodo-merge-docs.qodo.ai/tools/improve/) and [Improve](https://qodo-merge-docs.qodo.ai/tools/improve/). On the raw data collected, we employed various automatic and manual cleaning techniques to ensure the outputs were of the highest quality, and suitable for instruct-tuning. diff --git a/docs/docs/index.md b/docs/docs/index.md index e0b5bc413..3bc1ed4ba 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,38 +1,38 @@ # Overview -CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests. +Qodo Merge is an open-source tool to help efficiently review and handle pull requests. - See the [Installation Guide](./installation/index.md) for instructions on installing and running the tool on different git platforms. -- See the [Usage Guide](./usage-guide/index.md) for instructions on running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. +- See the [Usage Guide](./usage-guide/index.md) for instructions on running the Qodo Merge commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. - See the [Tools Guide](./tools/index.md) for a detailed description of the different tools. -## PR-Agent Docs Smart Search +## Qodo Merge Docs Smart Search To search the documentation site using natural language: 1) Comment `/help "your question"` in either: - - A pull request where PR-Agent is installed - - A [PR Chat](https://pr-agent-docs.codium.ai/chrome-extension/features/#pr-chat) + - A pull request where Qodo Merge is installed + - A [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) -2) PR-Agent will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links. +2) Qodo Merge will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links. -## PR-Agent Features +## Qodo Merge Features -PR-Agent offers extensive pull request functionalities across various git providers. +Qodo Merge offers extensive pull request functionalities across various git providers. | | | GitHub | Gitlab | Bitbucket | Azure DevOps | |-------|-----------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:| | TOOLS | Review | โœ… | โœ… | โœ… | โœ… | | | โฎ‘ Incremental | โœ… | | | | -| | โฎ‘ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | โœ… | | +| | โฎ‘ [SOC2 Compliance](https://qodo-merge-docs.qodo.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | โœ… | | | | Ask | โœ… | โœ… | โœ… | โœ… | | | Describe | โœ… | โœ… | โœ… | โœ… | -| | โฎ‘ [Inline file summary](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | | | +| | โฎ‘ [Inline file summary](https://qodo-merge-docs.qodo.ai/tools/describe/#inline-file-summary){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | | | | | Improve | โœ… | โœ… | โœ… | โœ… | | | โฎ‘ Extended | โœ… | โœ… | โœ… | โœ… | | | [Custom Prompt](./tools/custom_prompt.md){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | โœ… | | @@ -55,7 +55,7 @@ PR-Agent offers extensive pull request functionalities across various git provid | | [Static code analysis](./tools/analyze.md/){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | โœ… | | | | [Multiple configuration options](./usage-guide/configuration_options.md){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | โœ… | | -๐Ÿ’Ž marks a feature available only in [PR-Agent Pro](https://www.codium.ai/pricing/){:target="_blank"} +๐Ÿ’Ž marks a feature available only in [Qodo Merge Pro](https://www.codium.ai/pricing/){:target="_blank"} ## Example Results @@ -87,8 +87,8 @@ PR-Agent offers extensive pull request functionalities across various git provid ## How it Works -The following diagram illustrates PR-Agent tools and their flow: +The following diagram illustrates Qodo Merge tools and their flow: -![PR-Agent Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png) +![Qodo Merge Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png) -Check out the [core abilities](core-abilities/index.md) page for a comprehensive overview of the variety of core abilities used by PR-Agent. +Check out the [core abilities](core-abilities/index.md) page for a comprehensive overview of the variety of core abilities used by Qodo Merge. diff --git a/docs/docs/installation/azure.md b/docs/docs/installation/azure.md index ba97dbe6f..62ea49ba0 100644 --- a/docs/docs/installation/azure.md +++ b/docs/docs/installation/azure.md @@ -1,5 +1,5 @@ ## Azure DevOps Pipeline -You can use a pre-built Action Docker image to run PR-Agent as an Azure devops pipeline. +You can use a pre-built Action Docker image to run Qodo Merge as an Azure devops pipeline. add the following file to your repository under `azure-pipelines.yml`: ```yaml # Opt out of CI triggers @@ -47,11 +47,11 @@ stages: env: azure_devops__pat: $(azure_devops_pat) openai__key: $(OPENAI_KEY) - displayName: 'Run PR Agent' + displayName: 'Run Qodo Merge' ``` -This script will run PR-Agent on every new merge request, with the `improve`, `review`, and `describe` commands. +This script will run Qodo Merge on every new merge request, with the `improve`, `review`, and `describe` commands. Note that you need to export the `azure_devops__pat` and `OPENAI_KEY` variables in the Azure DevOps pipeline settings (Pipelines -> Library -> + Variable group): -![PR Agent Pro](https://codium.ai/images/pr_agent/azure_devops_pipeline_secrets.png){width=468} +![Qodo Merge Pro](https://codium.ai/images/pr_agent/azure_devops_pipeline_secrets.png){width=468} Make sure to give pipeline permissions to the `pr_agent` variable group. diff --git a/docs/docs/installation/bitbucket.md b/docs/docs/installation/bitbucket.md index 9023399bb..5d8dbd35c 100644 --- a/docs/docs/installation/bitbucket.md +++ b/docs/docs/installation/bitbucket.md @@ -1,7 +1,7 @@ ## Run as a Bitbucket Pipeline -You can use the Bitbucket Pipeline system to run PR-Agent on every pull request open or update. +You can use the Bitbucket Pipeline system to run Qodo Merge on every pull request open or update. 1. Add the following file in your repository bitbucket_pipelines.yml @@ -29,7 +29,7 @@ Note that comments on a PR are not supported in Bitbucket Pipeline. ## Run using CodiumAI-hosted Bitbucket app ๐Ÿ’Ž -Please contact visit [PR-Agent pro](https://www.codium.ai/pricing/) if you're interested in a hosted BitBucket app solution that provides full functionality including PR reviews and comment handling. It's based on the [bitbucket_app.py](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/git_providers/bitbucket_provider.py) implementation. +Please contact visit [Qodo Merge Pro](https://www.codium.ai/pricing/) if you're interested in a hosted BitBucket app solution that provides full functionality including PR reviews and comment handling. It's based on the [bitbucket_app.py](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/git_providers/bitbucket_provider.py) implementation. ## Bitbucket Server and Data Center diff --git a/docs/docs/installation/github.md b/docs/docs/installation/github.md index 83cd09813..2af960bd9 100644 --- a/docs/docs/installation/github.md +++ b/docs/docs/installation/github.md @@ -1,6 +1,6 @@ ## Run as a GitHub Action -You can use our pre-built Github Action Docker image to run PR-Agent as a Github Action. +You can use our pre-built Github Action Docker image to run Qodo Merge as a Github Action. 1) Add the following file to your repository under `.github/workflows/pr_agent.yml`: @@ -60,7 +60,7 @@ The GITHUB_TOKEN secret is automatically created by GitHub. 3) Merge this change to your main branch. When you open your next PR, you should see a comment from `github-actions` bot with a review of your PR, and instructions on how to use the rest of the tools. -4) You may configure PR-Agent by adding environment variables under the env section corresponding to any configurable property in the [configuration](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples: +4) You may configure Qodo Merge by adding environment variables under the env section corresponding to any configurable property in the [configuration](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples: ```yaml env: # ... previous environment values @@ -68,7 +68,7 @@ When you open your next PR, you should see a comment from `github-actions` bot w PR_REVIEWER.REQUIRE_TESTS_REVIEW: "false" # Disable tests review PR_CODE_SUGGESTIONS.NUM_CODE_SUGGESTIONS: 6 # Increase number of code suggestions ``` -See detailed usage instructions in the [USAGE GUIDE](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-action) +See detailed usage instructions in the [USAGE GUIDE](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-action) --- @@ -155,7 +155,7 @@ cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml 9. Install the app by navigating to the "Install App" tab and selecting your desired repositories. -> **Note:** When running PR-Agent from GitHub App, the default configuration file (configuration.toml) will be loaded. +> **Note:** When running Qodo Merge from GitHub app, the default configuration file (configuration.toml) will be loaded. > However, you can override the default tool parameters by uploading a local configuration file `.pr_agent.toml` > For more information please check out the [USAGE GUIDE](../usage-guide/automations_and_usage.md#github-app) --- diff --git a/docs/docs/installation/gitlab.md b/docs/docs/installation/gitlab.md index 07ed75fc1..1551d2a17 100644 --- a/docs/docs/installation/gitlab.md +++ b/docs/docs/installation/gitlab.md @@ -1,5 +1,5 @@ ## Run as a GitLab Pipeline -You can use a pre-built Action Docker image to run PR-Agent as a GitLab pipeline. This is a simple way to get started with PR-Agent without setting up your own server. +You can use a pre-built Action Docker image to run Qodo Merge as a GitLab pipeline. This is a simple way to get started with Qodo Merge without setting up your own server. (1) Add the following file to your repository under `.gitlab-ci.yml`: ```yaml @@ -26,8 +26,8 @@ pr_agent_job: rules: - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' ``` -This script will run PR-Agent on every new merge request. You can modify the `rules` section to run PR-Agent on different events. -You can also modify the `script` section to run different PR-Agent commands, or with different parameters by exporting different environment variables. +This script will run Qodo Merge on every new merge request. You can modify the `rules` section to run Qodo Merge on different events. +You can also modify the `script` section to run different Qodo Merge commands, or with different parameters by exporting different environment variables. (2) Add the following masked variables to your GitLab repository (CI/CD -> Variables): @@ -49,7 +49,7 @@ Note that if your base branches are not protected, don't set the variables as `p ``` WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))") ``` -3. Follow the instructions to build the Docker image, setup a secrets file and deploy on your own server from [here](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app) steps 4-7. +3. Follow the instructions to build the Docker image, setup a secrets file and deploy on your own server from [here](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-app) steps 4-7. 4. In the secrets file, fill in the following: - Your OpenAI key. diff --git a/docs/docs/installation/index.md b/docs/docs/installation/index.md index 905b86b3a..0dab771cf 100644 --- a/docs/docs/installation/index.md +++ b/docs/docs/installation/index.md @@ -1,12 +1,12 @@ # Installation -## Self-hosted PR-Agent -If you choose to host you own PR-Agent, you first need to acquire two tokens: +## Self-hosted Qodo Merge +If you choose to host you own Qodo Merge, you first need to acquire two tokens: -1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4 (or a key for other [language models](https://pr-agent-docs.codium.ai/usage-guide/changing_a_model/), if you prefer). +1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4 (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer). 2. A GitHub\GitLab\BitBucket personal access token (classic), with the repo scope. [GitHub from [here](https://github.com/settings/tokens)] -There are several ways to use self-hosted PR-Agent: +There are several ways to use self-hosted Qodo Merge: - [Locally](./locally.md) - [GitHub](./github.md) @@ -14,8 +14,8 @@ There are several ways to use self-hosted PR-Agent: - [BitBucket](./bitbucket.md) - [Azure DevOps](./azure.md) -## PR-Agent Pro ๐Ÿ’Ž -PR-Agent Pro, an app hosted by CodiumAI for GitHub\GitLab\BitBucket, is also available. +## Qodo Merge Pro ๐Ÿ’Ž +Qodo Merge Pro, an app hosted by CodiumAI for GitHub\GitLab\BitBucket, is also available.
-With PR-Agent Pro, installation is as simple as signing up and adding the PR-Agent app to your relevant repo. -See [here](https://pr-agent-docs.codium.ai/installation/pr_agent_pro/) for more details. \ No newline at end of file +With Qodo Merge Pro, installation is as simple as signing up and adding the Qodo Merge app to your relevant repo. +See [here](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/) for more details. \ No newline at end of file diff --git a/docs/docs/installation/pr_agent_pro.md b/docs/docs/installation/pr_agent_pro.md index 44c9c0279..499ab944d 100644 --- a/docs/docs/installation/pr_agent_pro.md +++ b/docs/docs/installation/pr_agent_pro.md @@ -1,33 +1,33 @@ -## Getting Started with PR-Agent Pro +## Getting Started with Qodo Merge Pro -PR-Agent Pro is a versatile application compatible with GitHub, GitLab, and BitBucket, hosted by CodiumAI. -See [here](https://pr-agent-docs.codium.ai/#pr-agent-pro) for more details about the benefits of using PR-Agent Pro. +Qodo Merge Pro is a versatile application compatible with GitHub, GitLab, and BitBucket, hosted by CodiumAI. +See [here](https://qodo-merge-docs.qodo.ai/#pr-agent-pro) for more details about the benefits of using Qodo Merge Pro. -Interested parties can subscribe to PR-Agent Pro through the following [link](https://www.codium.ai/pricing/). +Interested parties can subscribe to Qodo Merge Pro through the following [link](https://www.codium.ai/pricing/). After subscribing, you are granted the ability to easily install the application across any of your repositories. -![PR Agent Pro](https://codium.ai/images/pr_agent/pr_agent_pro_install.png){width=468} +![Qodo Merge Pro](https://codium.ai/images/pr_agent/pr_agent_pro_install.png){width=468} -Each user who wants to use PR-Agent pro needs to buy a seat. +Each user who wants to use Qodo Merge pro needs to buy a seat. Initially, CodiumAI offers a two-week trial period at no cost, after which continued access requires each user to secure a personal seat. -Once a user acquires a seat, they gain the flexibility to use PR-Agent Pro across any repository where it was enabled. +Once a user acquires a seat, they gain the flexibility to use Qodo Merge Pro across any repository where it was enabled. -Users without a purchased seat who interact with a repository featuring PR-Agent Pro are entitled to receive up to five complimentary feedbacks. -Beyond this limit, PR-Agent Pro will cease to respond to their inquiries unless a seat is purchased. +Users without a purchased seat who interact with a repository featuring Qodo Merge Pro are entitled to receive up to five complimentary feedbacks. +Beyond this limit, Qodo Merge Pro will cease to respond to their inquiries unless a seat is purchased. -## Install PR-Agent Pro for GitHub Enterprise Server -You can install PR-Agent Pro application on your GitHub Enterprise Server, and enjoy two weeks of free trial. -After the trial period, to continue using PR-Agent Pro, you will need to contact us for an [Enterprise license](https://www.codium.ai/pricing/). +## Install Qodo Merge Pro for GitHub Enterprise Server +You can install Qodo Merge Pro application on your GitHub Enterprise Server, and enjoy two weeks of free trial. +After the trial period, to continue using Qodo Merge Pro, you will need to contact us for an [Enterprise license](https://www.codium.ai/pricing/). -## Install PR-Agent Pro for GitLab (Teams & Enterprise) +## Install Qodo Merge Pro for GitLab (Teams & Enterprise) -Since GitLab platform does not support apps, installing PR-Agent Pro for GitLab is a bit more involved, and requires the following steps: +Since GitLab platform does not support apps, installing Qodo Merge Pro for GitLab is a bit more involved, and requires the following steps: ### Step 1 -Acquire a personal, project or group level access token. Enable the โ€œapiโ€ scope in order to allow PR-Agent to read pull requests, comment and respond to requests. +Acquire a personal, project or group level access token. Enable the โ€œapiโ€ scope in order to allow Qodo Merge to read pull requests, comment and respond to requests.
![Step 1](https://www.codium.ai/images/pr_agent/gitlab_pro_pat.png){width=750} @@ -65,4 +65,4 @@ Enable SSL verification: Check the box. Youโ€™re all set! -Open a new merge request or add a MR comment with one of PR-Agentโ€™s commands such as /review, /describe or /improve. \ No newline at end of file +Open a new merge request or add a MR comment with one of Qodo Mergeโ€™s commands such as /review, /describe or /improve. \ No newline at end of file diff --git a/docs/docs/overview/data_privacy.md b/docs/docs/overview/data_privacy.md index dff5ca601..5cec7f322 100644 --- a/docs/docs/overview/data_privacy.md +++ b/docs/docs/overview/data_privacy.md @@ -1,16 +1,16 @@ -## Self-hosted PR-Agent +## Self-hosted Qodo Merge -- If you self-host PR-Agent with your OpenAI (or other LLM provider) API key, it is between you and the provider. We don't send your code data to PR-Agent servers. +- If you self-host Qodo Merge with your OpenAI (or other LLM provider) API key, it is between you and the provider. We don't send your code data to Qodo Merge servers. -## PR-Agent Pro ๐Ÿ’Ž +## Qodo Merge Pro ๐Ÿ’Ž -- When using PR-Agent Pro ๐Ÿ’Ž, hosted by CodiumAI, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention. +- When using Qodo Merge Pro ๐Ÿ’Ž, hosted by CodiumAI, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention. -- For certain clients, CodiumAI-hosted PR-Agent Pro will use CodiumAIโ€™s proprietary models. If this is the case, you will be notified. +- For certain clients, CodiumAI-hosted Qodo Merge Pro will use CodiumAIโ€™s proprietary models. If this is the case, you will be notified. -- No passive collection of Code and Pull Requestsโ€™ data โ€” PR-Agent will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request. +- No passive collection of Code and Pull Requestsโ€™ data โ€” Qodo Merge will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request. -## PR-Agent Chrome extension +## Qodo Merge Chrome extension -- The [PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) will not send your code to any external servers. +- The [Qodo Merge Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) will not send your code to any external servers. diff --git a/docs/docs/overview/index.md b/docs/docs/overview/index.md index 19480a601..d4330a95b 100644 --- a/docs/docs/overview/index.md +++ b/docs/docs/overview/index.md @@ -1,38 +1,38 @@ # Overview -CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests. +Qodo Merge is an open-source tool to help efficiently review and handle pull requests. - See the [Installation Guide](./installation/index.md) for instructions on installing and running the tool on different git platforms. -- See the [Usage Guide](./usage-guide/index.md) for instructions on running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. +- See the [Usage Guide](./usage-guide/index.md) for instructions on running the Qodo Merge commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. - See the [Tools Guide](./tools/index.md) for a detailed description of the different tools. -## PR-Agent Docs Smart Search +## Qodo Merge Docs Smart Search To search the documentation site using natural language: 1) Comment `/help "your question"` in either: - - A pull request where PR-Agent is installed - - A [PR Chat](https://pr-agent-docs.codium.ai/chrome-extension/features/#pr-chat) + - A pull request where Qodo Merge is installed + - A [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) -2) PR-Agent will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links. +2) Qodo Merge will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links. -## PR-Agent Features +## Qodo Merge Features -PR-Agent offers extensive pull request functionalities across various git providers. +Qodo Merge offers extensive pull request functionalities across various git providers. | | | GitHub | Gitlab | Bitbucket | Azure DevOps | |-------|-----------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:| | TOOLS | Review | โœ… | โœ… | โœ… | โœ… | | | โฎ‘ Incremental | โœ… | | | | -| | โฎ‘ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | โœ… | โœ… | +| | โฎ‘ [SOC2 Compliance](https://qodo-merge-docs.qodo.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | โœ… | โœ… | | | Ask | โœ… | โœ… | โœ… | โœ… | | | Describe | โœ… | โœ… | โœ… | โœ… | -| | โฎ‘ [Inline file summary](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | | โœ… | +| | โฎ‘ [Inline file summary](https://qodo-merge-docs.qodo.ai/tools/describe/#inline-file-summary){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | | โœ… | | | Improve | โœ… | โœ… | โœ… | โœ… | | | โฎ‘ Extended | โœ… | โœ… | โœ… | โœ… | | | [Custom Prompt](./tools/custom_prompt.md){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | โœ… | โœ… | @@ -55,7 +55,7 @@ PR-Agent offers extensive pull request functionalities across various git provid | | [Static code analysis](./tools/analyze.md/){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | โœ… | โœ… | | | [Multiple configuration options](./usage-guide/configuration_options.md){:target="_blank"} ๐Ÿ’Ž | โœ… | โœ… | โœ… | โœ… | -๐Ÿ’Ž marks a feature available only in [PR-Agent Pro](https://www.codium.ai/pricing/){:target="_blank"} +๐Ÿ’Ž marks a feature available only in [Qodo Merge Pro](https://www.codium.ai/pricing/){:target="_blank"} ## Example Results @@ -87,8 +87,8 @@ PR-Agent offers extensive pull request functionalities across various git provid ## How it Works -The following diagram illustrates PR-Agent tools and their flow: +The following diagram illustrates Qodo Merge tools and their flow: -![PR-Agent Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png) +![Qodo Merge Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png) Check out the [PR Compression strategy](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt \ No newline at end of file diff --git a/docs/docs/overview/pr_agent_pro.md b/docs/docs/overview/pr_agent_pro.md index 962bd7d5e..a6424009f 100644 --- a/docs/docs/overview/pr_agent_pro.md +++ b/docs/docs/overview/pr_agent_pro.md @@ -1,52 +1,52 @@ ### Overview -[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. A complimentary two-week trial is offered, followed by a monthly subscription fee. -PR-Agent Pro is designed for companies and teams that require additional features and capabilities. It provides the following benefits: +[Qodo Merge Pro](https://www.codium.ai/pricing/) is a hosted version of Qodo Merge, provided by Qodo. A complimentary two-week trial is offered, followed by a monthly subscription fee. +Qodo Merge Pro is designed for companies and teams that require additional features and capabilities. It provides the following benefits: -1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\GitLab\BitBucket repo. +1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the Qodo Merge app to your GitHub\GitLab\BitBucket repo. -2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI and Claude accounts with zero data retention. +2. **Improved privacy** - No data will be stored or used to train models. Qodo Merge Pro will employ zero data retention, and will use an OpenAI and Claude accounts with zero data retention. -3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities. +3. **Improved support** - Qodo Merge Pro users will receive priority support, and will be able to request new features and capabilities. -4. **Supporting self-hosted git servers** - PR-Agent Pro can be installed on GitHub Enterprise Server, GitLab, and BitBucket. For more information, see the [installation guide](https://pr-agent-docs.codium.ai/installation/pr_agent_pro/). +4. **Supporting self-hosted git servers** - Qodo Merge Pro can be installed on GitHub Enterprise Server, GitLab, and BitBucket. For more information, see the [installation guide](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/). -5. **PR Chat** - PR-Agent Pro allows you to engage in [private chat](https://pr-agent-docs.codium.ai/chrome-extension/features/#pr-chat) about your pull requests on private repositories. +5. **PR Chat** - Qodo Merge Pro allows you to engage in [private chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) about your pull requests on private repositories. ### Additional features -Here are some of the additional features and capabilities that PR-Agent Pro offers: +Here are some of the additional features and capabilities that Qodo Merge Pro offers: | Feature | Description | |----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [**Model selection**](https://pr-agent-docs.codium.ai/usage-guide/PR_agent_pro_models/#pr-agent-pro-models) | Choose the model that best fits your needs, among top models like `GPT4` and `Claude-Sonnet-3.5` -| [**Global and wiki configuration**](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) | Control configurations for many repositories from a single location;
Edit configuration of a single repo without commiting code | -| [**Apply suggestions**](https://pr-agent-docs.codium.ai/tools/improve/#overview) | Generate commitable code from the relevant suggestions interactively by clicking on a checkbox | -| [**Suggestions impact**](https://pr-agent-docs.codium.ai/tools/improve/#assessing-impact) | Automatically mark suggestions that were implemented by the user (either directly in GitHub, or indirectly in the IDE) to enable tracking of the impact of the suggestions | -| [**CI feedback**](https://pr-agent-docs.codium.ai/tools/ci_feedback/) | Automatically analyze failed CI checks on GitHub and provide actionable feedback in the PR conversation, helping to resolve issues quickly | -| [**Advanced usage statistics**](https://www.codium.ai/contact/#/) | PR-Agent Pro offers detailed statistics at user, repository, and company levels, including metrics about PR-Agent usage, and also general statistics and insights | -| [**Incorporating companies' best practices**](https://pr-agent-docs.codium.ai/tools/improve/#best-practices) | Use the companies' best practices as reference to increase the effectiveness and the relevance of the code suggestions | -| [**Interactive triggering**](https://pr-agent-docs.codium.ai/tools/analyze/#example-usage) | Interactively apply different tools via the `analyze` command | -| [**SOC2 compliance check**](https://pr-agent-docs.codium.ai/tools/review/#configuration-options) | Ensures the PR contains a ticket to a project management system (e.g., Jira, Asana, Trello, etc.) -| [**Custom labels**](https://pr-agent-docs.codium.ai/tools/describe/#handle-custom-labels-from-the-repos-labels-page) | Define custom labels for PR-Agent to assign to the PR | +| [**Model selection**](https://qodo-merge-docs.qodo.ai/usage-guide/PR_agent_pro_models/#pr-agent-pro-models) | Choose the model that best fits your needs, among top models like `GPT4` and `Claude-Sonnet-3.5` +| [**Global and wiki configuration**](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) | Control configurations for many repositories from a single location;
Edit configuration of a single repo without commiting code | +| [**Apply suggestions**](https://qodo-merge-docs.qodo.ai/tools/improve/#overview) | Generate commitable code from the relevant suggestions interactively by clicking on a checkbox | +| [**Suggestions impact**](https://qodo-merge-docs.qodo.ai/tools/improve/#assessing-impact) | Automatically mark suggestions that were implemented by the user (either directly in GitHub, or indirectly in the IDE) to enable tracking of the impact of the suggestions | +| [**CI feedback**](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) | Automatically analyze failed CI checks on GitHub and provide actionable feedback in the PR conversation, helping to resolve issues quickly | +| [**Advanced usage statistics**](https://www.codium.ai/contact/#/) | Qodo Merge Pro offers detailed statistics at user, repository, and company levels, including metrics about Qodo Merge usage, and also general statistics and insights | +| [**Incorporating companies' best practices**](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) | Use the companies' best practices as reference to increase the effectiveness and the relevance of the code suggestions | +| [**Interactive triggering**](https://qodo-merge-docs.qodo.ai/tools/analyze/#example-usage) | Interactively apply different tools via the `analyze` command | +| [**SOC2 compliance check**](https://qodo-merge-docs.qodo.ai/tools/review/#configuration-options) | Ensures the PR contains a ticket to a project management system (e.g., Jira, Asana, Trello, etc.) +| [**Custom labels**](https://qodo-merge-docs.qodo.ai/tools/describe/#handle-custom-labels-from-the-repos-labels-page) | Define custom labels for Qodo Merge to assign to the PR | ### Additional tools -Here are additional tools that are available only for PR-Agent Pro users: +Here are additional tools that are available only for Qodo Merge Pro users: | Feature | Description | |---------|-------------| -| [**Custom Prompt Suggestions**](https://pr-agent-docs.codium.ai/tools/custom_prompt/) | Generate code suggestions based on custom prompts from the user | -| [**Analyze PR components**](https://pr-agent-docs.codium.ai/tools/analyze/) | Identify the components that changed in the PR, and enable to interactively apply different tools to them | -| [**Tests**](https://pr-agent-docs.codium.ai/tools/test/) | Generate tests for code components that changed in the PR | -| [**PR documentation**](https://pr-agent-docs.codium.ai/tools/documentation/) | Generate docstring for code components that changed in the PR | -| [**Improve Component**](https://pr-agent-docs.codium.ai/tools/improve_component/) | Generate code suggestions for code components that changed in the PR | -| [**Similar code search**](https://pr-agent-docs.codium.ai/tools/similar_code/) | Search for similar code in the repository, organization, or entire GitHub | +| [**Custom Prompt Suggestions**](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) | Generate code suggestions based on custom prompts from the user | +| [**Analyze PR components**](https://qodo-merge-docs.qodo.ai/tools/analyze/) | Identify the components that changed in the PR, and enable to interactively apply different tools to them | +| [**Tests**](https://qodo-merge-docs.qodo.ai/tools/test/) | Generate tests for code components that changed in the PR | +| [**PR documentation**](https://qodo-merge-docs.qodo.ai/tools/documentation/) | Generate docstring for code components that changed in the PR | +| [**Improve Component**](https://qodo-merge-docs.qodo.ai/tools/improve_component/) | Generate code suggestions for code components that changed in the PR | +| [**Similar code search**](https://qodo-merge-docs.qodo.ai/tools/similar_code/) | Search for similar code in the repository, organization, or entire GitHub | ### Supported languages -PR-Agent Pro leverages the world's leading code models - Claude 3.5 Sonnet and GPT-4. +Qodo Merge Pro leverages the world's leading code models - Claude 3.5 Sonnet and GPT-4. As a result, its primary tools such as `describe`, `review`, and `improve`, as well as the PR-chat feature, support virtually all programming languages. -For specialized commands that require static code analysis, PR-Agent Pro offers support for specific languages. For more details about features that require static code analysis, please refer to the [documentation](https://pr-agent-docs.codium.ai/tools/analyze/#overview). \ No newline at end of file +For specialized commands that require static code analysis, Qodo Merge Pro offers support for specific languages. For more details about features that require static code analysis, please refer to the [documentation](https://qodo-merge-docs.qodo.ai/tools/analyze/#overview). \ No newline at end of file diff --git a/docs/docs/tools/custom_labels.md b/docs/docs/tools/custom_labels.md index b9d85fa2d..67ce41dc4 100644 --- a/docs/docs/tools/custom_labels.md +++ b/docs/docs/tools/custom_labels.md @@ -28,7 +28,7 @@ When working from CLI, you need to apply the [configuration changes](#configurat To enable custom labels, you need to apply the [configuration changes](#configuration-options) to the local `.pr_agent.toml` file in you repository. #### 3. Handle custom labels from the Repo's labels page ๐Ÿ’Ž -> This feature is available only in PR-Agent Pro +> This feature is available only in Qodo Merge Pro * GitHub : `https://github.com/{owner}/{repo}/labels`, or click on the "Labels" tab in the issues or PRs page. * GitLab : `https://gitlab.com/{owner}/{repo}/-/labels`, or click on "Manage" -> "Labels" on the left menu. diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md index 9fe50e668..bd24da1e3 100644 --- a/docs/docs/tools/describe.md +++ b/docs/docs/tools/describe.md @@ -25,7 +25,7 @@ If you want to edit [configurations](#configuration-options), add the relevant o ### Automatic triggering -To run the `describe` automatically when a PR is opened, define in a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/#wiki-configuration-file): +To run the `describe` automatically when a PR is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file): ``` [github_app] pr_commands = [ @@ -157,7 +157,7 @@ The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary` The default labels of the describe tool are quite generic, since they are meant to be used in any repo: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`]. You can define custom labels that are relevant for your repo and use cases. -Custom labels can be defined in a [configuration file](https://pr-agent-docs.codium.ai/tools/custom_labels/#configuration-options), or directly in the repo's [labels page](#handle-custom-labels-from-the-repos-labels-page). +Custom labels can be defined in a [configuration file](https://qodo-merge-docs.qodo.ai/tools/custom_labels/#configuration-options), or directly in the repo's [labels page](#handle-custom-labels-from-the-repos-labels-page). Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it. Each label description should be a **conditional statement**, that indicates if to add the label to the PR or not, according to the PR content. @@ -205,7 +205,7 @@ The description should be comprehensive and detailed, indicating when to add the ## Usage Tips !!! tip "Automation" - - When you first install PR-Agent app, the [default mode](../usage-guide/automations_and_usage.md#github-app) for the describe tool is: + - When you first install Qodo Merge app, the [default mode](../usage-guide/automations_and_usage.md#github-app) for the describe tool is: ``` pr_commands = ["/describe", ...] ``` diff --git a/docs/docs/tools/help.md b/docs/docs/tools/help.md index 5cfc1e81f..ba68477ff 100644 --- a/docs/docs/tools/help.md +++ b/docs/docs/tools/help.md @@ -1,6 +1,6 @@ ## Overview The `help` tool provides a list of all the available tools and their descriptions. -For PR-Agent Pro users, it also enables to trigger each tool by checking the relevant box. +For Qodo Merge Pro users, it also enables to trigger each tool by checking the relevant box. It can be invoked manually by commenting on any PR: ``` diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index c0ba56970..b4e24a385 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -9,7 +9,7 @@ The tool can be triggered automatically every time a new PR is [opened](../usage ![code_suggestions_as_comment_open.png](https://codium.ai/images/pr_agent/code_suggestions_as_comment_open.png){width=512} -Note that the `Apply this suggestion` checkbox, which interactively converts a suggestion into a commitable code comment, is available only for PR-Agent Pro ๐Ÿ’Ž users. +Note that the `Apply this suggestion` checkbox, which interactively converts a suggestion into a commitable code comment, is available only for Qodo Merge Pro ๐Ÿ’Ž users. ## Example usage @@ -36,7 +36,7 @@ Also note that collapsible are not supported in _Bitbucket_. Hence, the suggesti ### Automatic triggering -To run the `improve` automatically when a PR is opened, define in a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/#wiki-configuration-file): +To run the `improve` automatically when a PR is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file): ``` [github_app] pr_commands = [ @@ -54,14 +54,14 @@ num_code_suggestions_per_chunk = ... ### Assessing Impact ๐Ÿ’Ž -Note that PR-Agent pro tracks two types of implementations: +Note that Qodo Merge pro tracks two types of implementations: - Direct implementation - when the user directly applies the suggestion by clicking the `Apply` checkbox. -- Indirect implementation - when the user implements the suggestion in their IDE environment. In this case, PR-Agent will utilize, after each commit, a dedicated logic to identify if a suggestion was implemented, and will mark it as implemented. +- Indirect implementation - when the user implements the suggestion in their IDE environment. In this case, Qodo Merge will utilize, after each commit, a dedicated logic to identify if a suggestion was implemented, and will mark it as implemented. ![code_suggestions_asses_impact](https://codium.ai/images/pr_agent/code_suggestions_asses_impact.png){width=512} -In post-process, PR-Agent counts the number of suggestions that were implemented, and provides general statistics and insights about the suggestions' impact on the PR process. +In post-process, Qodo Merge counts the number of suggestions that were implemented, and provides general statistics and insights about the suggestions' impact on the PR process. ![code_suggestions_asses_impact_stats_1](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_1.png){width=512} @@ -108,17 +108,17 @@ code_suggestions_self_review_text = "... (your text here) ..." ### How many code suggestions are generated? -PR-Agent uses a dynamic strategy to generate code suggestions based on the size of the pull request (PR). Here's how it works: +Qodo Merge uses a dynamic strategy to generate code suggestions based on the size of the pull request (PR). Here's how it works: 1) Chunking large PRs: -- PR-Agent divides large PRs into 'chunks'. +- Qodo Merge divides large PRs into 'chunks'. - Each chunk contains up to `pr_code_suggestions.max_context_tokens` tokens (default: 14,000). 2) Generating suggestions: -- For each chunk, PR-Agent generates up to `pr_code_suggestions.num_code_suggestions_per_chunk` suggestions (default: 4). +- For each chunk, Qodo Merge generates up to `pr_code_suggestions.num_code_suggestions_per_chunk` suggestions (default: 4). This approach has two main benefits: @@ -126,7 +126,7 @@ This approach has two main benefits: - Scalability: The number of suggestions scales with the PR size, rather than being fixed. - Quality: By processing smaller chunks, the AI can maintain higher quality suggestions, as larger contexts tend to decrease AI performance. -Note: Chunking is primarily relevant for large PRs. For most PRs (up to 500 lines of code), PR-Agent will be able to process the entire code in a single call. +Note: Chunking is primarily relevant for large PRs. For most PRs (up to 500 lines of code), Qodo Merge will be able to process the entire code in a single call. ### 'Extra instructions' and 'best practices' @@ -172,7 +172,7 @@ This file is only an example. Since it is used as a prompt for an AI model, we w 2) A lengthy file probably represent a more "**generic**" set of guidelines, which the AI model is already familiar with. The objective is to focus on a more targeted set of guidelines tailored to the specific needs of this project. ##### Local and global best practices -By default, PR-Agent will look for a local `best_practices.md` wiki file in the root of the relevant local repo. +By default, Qodo Merge will look for a local `best_practices.md` wiki file in the root of the relevant local repo. If you want to enable also a global `best_practices.md` wiki file, set first in the global configuration file: @@ -181,7 +181,7 @@ If you want to enable also a global `best_practices.md` wiki file, set first in enable_global_best_practices = true ``` -Then, create a `best_practices.md` wiki file in the root of [global](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/#global-configuration-file) configuration repository, `pr-agent-settings`. +Then, create a `best_practices.md` wiki file in the root of [global](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) configuration repository, `pr-agent-settings`. ##### Example results @@ -259,11 +259,11 @@ Using a combination of both can help the AI model to provide relevant and tailor ## A note on code suggestions quality - AI models for code are getting better and better (Sonnet-3.5 and GPT-4), but they are not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Critical reading and judgment are required. -- While mistakes of the AI are rare but can happen, a real benefit from the suggestions of the `improve` (and [`review`](https://pr-agent-docs.codium.ai/tools/review/)) tool is to catch, with high probability, **mistakes or bugs done by the PR author**, when they happen. So, it's a good practice to spend the needed ~30-60 seconds to review the suggestions, even if not all of them are always relevant. +- While mistakes of the AI are rare but can happen, a real benefit from the suggestions of the `improve` (and [`review`](https://qodo-merge-docs.qodo.ai/tools/review/)) tool is to catch, with high probability, **mistakes or bugs done by the PR author**, when they happen. So, it's a good practice to spend the needed ~30-60 seconds to review the suggestions, even if not all of them are always relevant. - The hierarchical structure of the suggestions is designed to help the user to _quickly_ understand them, and to decide which ones are relevant and which are not: - Only if the `Category` header is relevant, the user should move to the summarized suggestion description - Only if the summarized suggestion description is relevant, the user should click on the collapsible, to read the full suggestion description with a code preview example. -- In addition, we recommend to use the [`extra_instructions`](https://pr-agent-docs.codium.ai/tools/improve/#extra-instructions-and-best-practices) field to guide the model to suggestions that are more relevant to the specific needs of the project. -- The interactive [PR chat](https://pr-agent-docs.codium.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model. +- In addition, we recommend to use the [`extra_instructions`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) field to guide the model to suggestions that are more relevant to the specific needs of the project. +- The interactive [PR chat](https://qodo-merge-docs.qodo.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model. diff --git a/docs/docs/tools/index.md b/docs/docs/tools/index.md index 10aaf88ab..394bdbabf 100644 --- a/docs/docs/tools/index.md +++ b/docs/docs/tools/index.md @@ -1,6 +1,6 @@ # Tools -Here is a list of PR-Agent tools, each with a dedicated page that explains how to use it: +Here is a list of Qodo Merge tools, each with a dedicated page that explains how to use it: | Tool | Description | |------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| @@ -19,4 +19,4 @@ Here is a list of PR-Agent tools, each with a dedicated page that explains how t | **๐Ÿ’Ž [Improve Component (`/improve_component component_name`](./improve_component.md))** | Generates code suggestions for a specific code component that changed in the PR | | **๐Ÿ’Ž [CI Feedback (`/checks ci_job`](./ci_feedback.md))** | Automatically generates feedback and analysis for a failed CI job | -Note that the tools marked with ๐Ÿ’Ž are available only for PR-Agent Pro users. \ No newline at end of file +Note that the tools marked with ๐Ÿ’Ž are available only for Qodo Merge Pro users. \ No newline at end of file diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md index 27af7d93d..16765629b 100644 --- a/docs/docs/tools/review.md +++ b/docs/docs/tools/review.md @@ -8,7 +8,7 @@ The tool can be triggered automatically every time a new PR is [opened](../usage Note that the main purpose of the `review` tool is to provide the **PR reviewer** with useful feedbacks and insights. The PR author, in contrast, may prefer to save time and focus on the output of the [improve](./improve.md) tool, which provides actionable code suggestions. -(Read more about the different personas in the PR process and how PR-Agent aims to assist them in our [blog](https://www.codium.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)) +(Read more about the different personas in the PR process and how Qodo Merge aims to assist them in our [blog](https://www.codium.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)) ## Example usage @@ -30,7 +30,7 @@ If you want to edit [configurations](#configuration-options), add the relevant o ### Automatic triggering -To run the `review` automatically when a PR is opened, define in a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/#wiki-configuration-file): +To run the `review` automatically when a PR is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file): ``` [github_app] pr_commands = [ @@ -49,7 +49,7 @@ num_code_suggestions = ... [//]: # () [//]: # (### Incremental Mode) -[//]: # (Incremental review only considers changes since the last PR-Agent review. This can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again.) +[//]: # (Incremental review only considers changes since the last Qodo Merge review. This can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again.) [//]: # (For invoking the incremental mode, the following command can be used:) @@ -198,7 +198,7 @@ If enabled, the `review` tool can approve a PR when a specific comment, `/review On the other hand, if you find one of the enabled features to be irrelevant for your use case, disable it. No default configuration can fit all use cases. !!! tip "Automation" - When you first install PR-Agent app, the [default mode](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened) for the `review` tool is: + When you first install Qodo Merge app, the [default mode](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened) for the `review` tool is: ``` pr_commands = ["/review --pr_reviewer.num_code_suggestions=0", ...] ``` @@ -237,7 +237,7 @@ If enabled, the `review` tool can approve a PR when a specific comment, `/review !!! tip "Auto-approval" - PR-Agent can approve a PR when a specific comment is invoked. + Qodo Merge can approve a PR when a specific comment is invoked. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: ``` @@ -251,7 +251,7 @@ If enabled, the `review` tool can approve a PR when a specific comment, `/review ``` /review auto_approve ``` - PR-Agent will automatically approve the PR, and add a comment with the approval. + Qodo Merge will automatically approve the PR, and add a comment with the approval. You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` label is equal or below a certain threshold, by adjusting the flag: diff --git a/docs/docs/tools/similar_code.md b/docs/docs/tools/similar_code.md index 5f2af5c8b..c992a2627 100644 --- a/docs/docs/tools/similar_code.md +++ b/docs/docs/tools/similar_code.md @@ -8,9 +8,9 @@ For example: ![similar code global](https://codium.ai/images/pr_agent/similar_code_global2.png){width=768} -PR-Agent will examine the code component and will extract the most relevant keywords to search for similar code: +Qodo Merge will examine the code component and will extract the most relevant keywords to search for similar code: -- `extracted keywords`: the keywords that were extracted from the code by PR-Agent. the link will open a search page with the extracted keywords, to allow the user to modify the search if needed. +- `extracted keywords`: the keywords that were extracted from the code by Qodo Merge. the link will open a search page with the extracted keywords, to allow the user to modify the search if needed. - `search context`: the context in which the search will be performed, organization's codebase or open-source code (Global). - `similar code`: the most similar code components found. the link will open the code component in the relevant file. - `relevant repositories`: the open-source repositories in which that are relevant to the searched code component and it's keywords. diff --git a/docs/docs/usage-guide/PR_agent_pro_models.md b/docs/docs/usage-guide/PR_agent_pro_models.md index c707a7cc1..367e1b9c3 100644 --- a/docs/docs/usage-guide/PR_agent_pro_models.md +++ b/docs/docs/usage-guide/PR_agent_pro_models.md @@ -1,17 +1,17 @@ -## PR-Agent Pro Models +## Qodo Merge Pro Models -The default models used by PR-Agent Pro are a combination of Claude-3.5-sonnet and OpenAI's GPT-4 models. +The default models used by Qodo Merge Pro are a combination of Claude-3.5-sonnet and OpenAI's GPT-4 models. -Users can configure PR-Agent Pro to use solely a specific model by editing the [configuration](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) file. +Users can configure Qodo Merge Pro to use solely a specific model by editing the [configuration](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) file. -For example, to restrict PR-Agent Pro to using only `Claude-3.5-sonnet`, add this setting: +For example, to restrict Qodo Merge Pro to using only `Claude-3.5-sonnet`, add this setting: ``` [config] model="claude-3-5-sonnet" ``` -Or to restrict PR-Agent Pro to using only `GPT-4o`, add this setting: +Or to restrict Qodo Merge Pro to using only `GPT-4o`, add this setting: ``` [config] model="gpt-4o" diff --git a/docs/docs/usage-guide/additional_configurations.md b/docs/docs/usage-guide/additional_configurations.md index 78ca4113c..00b0840ed 100644 --- a/docs/docs/usage-guide/additional_configurations.md +++ b/docs/docs/usage-guide/additional_configurations.md @@ -1,6 +1,6 @@ ## Show possible configurations The possible configurations of pr-agent are stored in [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml). -In the [tools](https://pr-agent-docs.codium.ai/tools/) page you can find explanations on how to use these configurations for each tool. +In the [tools](https://qodo-merge-docs.qodo.ai/tools/) page you can find explanations on how to use these configurations for each tool. To print all the available configurations as a comment on your PR, you can use the following command: ``` @@ -22,7 +22,7 @@ Will output an additional field showing the actual configurations used for the ` ## Ignoring files from analysis -In some cases, you may want to exclude specific files or directories from the analysis performed by CodiumAI PR-Agent. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendor code. +In some cases, you may want to exclude specific files or directories from the analysis performed by Qodo Merge. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendor code. You can ignore files or folders using the following methods: - `IGNORE.GLOB` @@ -52,7 +52,7 @@ regex = ['.*\.py$'] ## Extra instructions -All PR-Agent tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage: +All Qodo Merge tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage: ``` /update_changelog --pr_update_changelog.extra_instructions="Make sure to update also the version ..." ``` @@ -85,7 +85,7 @@ By default, around any change in your PR, git patch provides three lines of cont code line that already existed in the file... ``` -PR-Agent will try to increase the number of lines of context, via the parameter: +Qodo Merge will try to increase the number of lines of context, via the parameter: ``` [config] patch_extra_lines_before=3 @@ -94,12 +94,12 @@ patch_extra_lines_after=1 Increasing this number provides more context to the model, but will also increase the token budget, and may overwhelm the model with too much information, unrelated to the actual PR code changes. -If the PR is too large (see [PR Compression strategy](https://github.com/Codium-ai/pr-agent/blob/main/PR_COMPRESSION.md)), PR-Agent may automatically set this number to 0, and will use the original git patch. +If the PR is too large (see [PR Compression strategy](https://github.com/Codium-ai/pr-agent/blob/main/PR_COMPRESSION.md)), Qodo Merge may automatically set this number to 0, and will use the original git patch. ## Editing the prompts -The prompts for the various PR-Agent tools are defined in the `pr_agent/settings` folder. +The prompts for the various Qodo Merge tools are defined in the `pr_agent/settings` folder. In practice, the prompts are loaded and stored as a standard setting object. Hence, editing them is similar to editing any other configuration value - just place the relevant key in `.pr_agent.toml`file, and override the default value. @@ -138,7 +138,7 @@ LANGSMITH_BASE_URL= ## Ignoring automatic commands in PRs -In some cases, you may want to automatically ignore specific PRs . PR-Agent enables you to ignore PR with a specific title, or from/to specific branches (regex matching). +In some cases, you may want to automatically ignore specific PRs . Qodo Merge enables you to ignore PR with a specific title, or from/to specific branches (regex matching). To ignore PRs with a specific title such as "[Bump]: ...", you can add the following to your `configuration.toml` file: diff --git a/docs/docs/usage-guide/automations_and_usage.md b/docs/docs/usage-guide/automations_and_usage.md index 0f780d80d..8d845e252 100644 --- a/docs/docs/usage-guide/automations_and_usage.md +++ b/docs/docs/usage-guide/automations_and_usage.md @@ -1,5 +1,5 @@ ## Local repo (CLI) -When running from your locally cloned PR-Agent repo (CLI), your local configuration file will be used. +When running from your locally cloned Qodo Merge repo (CLI), your local configuration file will be used. Examples of invoking the different tools via the CLI: - **Review**: `python -m pr_agent.cli --pr_url= review` @@ -28,7 +28,7 @@ This is useful for debugging or experimenting with different tools. (3) -**git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in a configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported: +**git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in a configuration file determines the GIT provider that will be used by Qodo Merge. Currently, the following providers are supported: ` "github", "gitlab", "bitbucket", "azure", "codecommit", "local", "gerrit" ` @@ -39,7 +39,7 @@ Default is "github". ### Online usage -Online usage means invoking PR-Agent tools by [comments](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR. +Online usage means invoking Qodo Merge tools by [comments](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR. Commands for invoking the different tools via comments: - **Review**: `/review` @@ -60,8 +60,8 @@ Any configuration value in [configuration file](https://github.com/Codium-ai/pr- ## GitHub App -!!! note "Configurations for PR-Agent Pro" - PR-Agent Pro for GitHub is an App, hosted by CodiumAI. So all the instructions below are relevant also for PR-Agent Pro users. +!!! note "Configurations for Qodo Merge Pro" + Qodo Merge Pro for GitHub is an App, hosted by CodiumAI. So all the instructions below are relevant also for Qodo Merge Pro users. Same goes for [GitLab webhook](#gitlab-webhook) and [BitBucket App](#bitbucket-app) sections. ### GitHub app automatic tools when a new PR is opened @@ -77,7 +77,7 @@ pr_commands = [ "/improve", ] ``` -This means that when a new PR is opened/reopened or marked as ready for review, PR-Agent will run the `describe`, `review` and `improve` tools. +This means that when a new PR is opened/reopened or marked as ready for review, Qodo Merge will run the `describe`, `review` and `improve` tools. For the `review` tool, for example, the `num_code_suggestions` parameter will be set to 0. You can override the default tool parameters by using one the three options for a [configuration file](https://codium-ai.github.io/Docs-PR-Agent/usage-guide/#configuration-options): **wiki**, **local**, or **global**. @@ -108,10 +108,10 @@ push_commands = [ "/review --pr_reviewer.num_code_suggestions=0 --pr_reviewer.final_update_message=false", ] ``` -This means that when new code is pushed to the PR, the PR-Agent will run the `describe` and `review` tools, with the specified parameters. +This means that when new code is pushed to the PR, the Qodo Merge will run the `describe` and `review` tools, with the specified parameters. ## GitHub Action -`GitHub Action` is a different way to trigger PR-Agent tools, and uses a different configuration mechanism than `GitHub App`.
+`GitHub Action` is a different way to trigger Qodo Merge tools, and uses a different configuration mechanism than `GitHub App`.
You can configure settings for `GitHub Action` by adding environment variables under the env section in `.github/workflows/pr_agent.yml` file. Specifically, start by setting the following environment variables: ```yaml @@ -133,14 +133,14 @@ If not set, the default configuration is `["opened", "reopened", "ready_for_revi Review result is output as JSON to `steps.{step-id}.outputs.review` property. The JSON structure is equivalent to the yaml data structure defined in [pr_reviewer_prompts.toml](https://github.com/idubnori/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml). -Note that you can give additional config parameters by adding environment variables to `.github/workflows/pr_agent.yml`, or by using a `.pr_agent.toml` [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/#global-configuration-file) in the root of your repo +Note that you can give additional config parameters by adding environment variables to `.github/workflows/pr_agent.yml`, or by using a `.pr_agent.toml` [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) in the root of your repo For example, you can set an environment variable: `pr_description.publish_labels=false`, or add a `.pr_agent.toml` file with the following content: ``` [pr_description] publish_labels = false ``` -to prevent PR-Agent from publishing labels when running the `describe` tool. +to prevent Qodo Merge from publishing labels when running the `describe` tool. ## GitLab Webhook After setting up a GitLab webhook, to control which commands will run automatically when a new MR is opened, you can set the `pr_commands` parameter in the configuration file, similar to the GitHub App: @@ -168,7 +168,7 @@ push_commands = [ Note that to use the 'handle_push_trigger' feature, you need to give the gitlab webhook also the "Push events" scope. ## BitBucket App -Similar to GitHub app, when running PR-Agent from BitBucket App, the default [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) from a pre-built docker will be initially loaded. +Similar to GitHub app, when running Qodo Merge from BitBucket App, the default [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) from a pre-built docker will be initially loaded. By uploading a local `.pr_agent.toml` file to the root of the repo's main branch, you can edit and customize any configuration parameter. Note that you need to upload `.pr_agent.toml` prior to creating a PR, in order for the configuration to take effect. @@ -182,8 +182,8 @@ Each time you invoke a `/review` tool, it will use the extra instructions you se Note that among other limitations, BitBucket provides relatively low rate-limits for applications (up to 1000 requests per hour), and does not provide an API to track the actual rate-limit usage. -If you experience lack of responses from PR-Agent, you might want to set: `bitbucket_app.avoid_full_files=true` in your configuration file. -This will prevent PR-Agent from acquiring the full file content, and will only use the diff content. This will reduce the number of requests made to BitBucket, at the cost of small decrease in accuracy, as dynamic context will not be applicable. +If you experience lack of responses from Qodo Merge, you might want to set: `bitbucket_app.avoid_full_files=true` in your configuration file. +This will prevent Qodo Merge from acquiring the full file content, and will only use the diff content. This will reduce the number of requests made to BitBucket, at the cost of small decrease in accuracy, as dynamic context will not be applicable. ### BitBucket Self-Hosted App automatic tools diff --git a/docs/docs/usage-guide/configuration_options.md b/docs/docs/usage-guide/configuration_options.md index 70e9f9f8f..d09d23fb3 100644 --- a/docs/docs/usage-guide/configuration_options.md +++ b/docs/docs/usage-guide/configuration_options.md @@ -1,4 +1,4 @@ -The different tools and sub-tools used by CodiumAI PR-Agent are adjustable via the **[configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)**. +The different tools and sub-tools used by Qodo Merge are adjustable via the **[configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)**. In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L16) section in the configuration file. See the [Tools Guide](https://codium-ai.github.io/Docs-PR-Agent/tools/) for a detailed description of the different tools and their configurations. @@ -20,7 +20,7 @@ In terms of precedence, wiki configurations will override local configurations, `Platforms supported: GitHub, GitLab` -With PR-Agent-Pro, you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo. +With Qodo Merge-Pro, you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo. The advantage of this method is that it allows to set configurations without needing to commit new content to the repo - just edit the wiki page and **save**. @@ -34,7 +34,7 @@ An example content: generate_ai_title=true ``` -PR-Agent will know to remove the surrounding quotes when reading the configuration content. +Qodo Merge will know to remove the surrounding quotes when reading the configuration content. ## Local configuration file diff --git a/docs/docs/usage-guide/index.md b/docs/docs/usage-guide/index.md index 637048c19..bd1b93f49 100644 --- a/docs/docs/usage-guide/index.md +++ b/docs/docs/usage-guide/index.md @@ -1,7 +1,7 @@ # Usage guide -This page provides a detailed guide on how to use PR-Agent. -It includes information on how to adjust PR-Agent configurations, define which tools will run automatically, and other advanced configurations. +This page provides a detailed guide on how to use Qodo Merge. +It includes information on how to adjust Qodo Merge configurations, define which tools will run automatically, and other advanced configurations. - [Introduction](./introduction.md) @@ -23,4 +23,4 @@ It includes information on how to adjust PR-Agent configurations, define which t - [Changing a model](./additional_configurations.md#changing-a-model) - [Patch Extra Lines](./additional_configurations.md#patch-extra-lines) - [Editing the prompts](./additional_configurations.md#editing-the-prompts) -- [PR-Agent Pro Models](./PR_agent_pro_models.md) \ No newline at end of file +- [Qodo Merge Pro Models](./PR_agent_pro_models.md) \ No newline at end of file diff --git a/docs/docs/usage-guide/introduction.md b/docs/docs/usage-guide/introduction.md index 6fa6855d4..687500a4e 100644 --- a/docs/docs/usage-guide/introduction.md +++ b/docs/docs/usage-guide/introduction.md @@ -1,13 +1,13 @@ -After [installation](https://pr-agent-docs.codium.ai/installation/), there are three basic ways to invoke CodiumAI PR-Agent: +After [installation](https://qodo-merge-docs.qodo.ai/installation/), there are three basic ways to invoke Qodo Merge: 1. Locally running a CLI command 2. Online usage - by [commenting](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR -3. Enabling PR-Agent tools to run automatically when a new PR is opened +3. Enabling Qodo Merge tools to run automatically when a new PR is opened -Specifically, CLI commands can be issued by invoking a pre-built [docker image](https://pr-agent-docs.codium.ai/installation/locally/#using-docker-image), or by invoking a [locally cloned repo](https://pr-agent-docs.codium.ai/installation/locally/#run-from-source). +Specifically, CLI commands can be issued by invoking a pre-built [docker image](https://qodo-merge-docs.qodo.ai/installation/locally/#using-docker-image), or by invoking a [locally cloned repo](https://qodo-merge-docs.qodo.ai/installation/locally/#run-from-source). -For online usage, you will need to setup either a [GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app) or a [GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action) (GitHub), a [GitLab webhook](https://pr-agent-docs.codium.ai/installation/gitlab/#run-a-gitlab-webhook-server) (GitLab), or a [BitBucket App](https://pr-agent-docs.codium.ai/installation/bitbucket/#run-using-codiumai-hosted-bitbucket-app) (BitBucket). -These platforms also enable to run PR-Agent specific tools automatically when a new PR is opened, or on each push to a branch. +For online usage, you will need to setup either a [GitHub App](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-app) or a [GitHub Action](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) (GitHub), a [GitLab webhook](https://qodo-merge-docs.qodo.ai/installation/gitlab/#run-a-gitlab-webhook-server) (GitLab), or a [BitBucket App](https://qodo-merge-docs.qodo.ai/installation/bitbucket/#run-using-codiumai-hosted-bitbucket-app) (BitBucket). +These platforms also enable to run Qodo Merge specific tools automatically when a new PR is opened, or on each push to a branch. diff --git a/docs/docs/usage-guide/mail_notifications.md b/docs/docs/usage-guide/mail_notifications.md index f25c7eaa0..42fd7a8d1 100644 --- a/docs/docs/usage-guide/mail_notifications.md +++ b/docs/docs/usage-guide/mail_notifications.md @@ -1,15 +1,15 @@ Unfortunately, it is not possible in GitHub to disable mail notifications from a specific user. -If you are subscribed to notifications for a repo with PR-Agent, we recommend turning off notifications for PR comments, to avoid lengthy emails: +If you are subscribed to notifications for a repo with Qodo Merge, we recommend turning off notifications for PR comments, to avoid lengthy emails: ![notifications](https://codium.ai/images/pr_agent/notifications.png){width=512} -As an alternative, you can filter in your mail provider the notifications specifically from the PR-Agent bot, [see how](https://www.quora.com/How-can-you-filter-emails-for-specific-people-in-Gmail#:~:text=On%20the%20Filters%20and%20Blocked,the%20body%20of%20the%20email). +As an alternative, you can filter in your mail provider the notifications specifically from the Qodo Merge bot, [see how](https://www.quora.com/How-can-you-filter-emails-for-specific-people-in-Gmail#:~:text=On%20the%20Filters%20and%20Blocked,the%20body%20of%20the%20email). ![filter_mail_notifications](https://codium.ai/images/pr_agent/filter_mail_notifications.png){width=512} -Another option to reduce the mail overload, yet still receive notifications on PR-Agent tools, is to disable the help collapsible section in PR-Agent bot comments. +Another option to reduce the mail overload, yet still receive notifications on Qodo Merge tools, is to disable the help collapsible section in Qodo Merge bot comments. This can done by setting `enable_help_text=false` for the relevant tool in the configuration file. For example, to disable the help text for the `pr_reviewer` tool, set: ``` diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 1e0ce4d35..f6957536a 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,11 +1,11 @@ -site_name: PR-Agent Documentation +site_name: Qodo Merge (formerly known as PR-Agent) repo_url: https://github.com/Codium-ai/pr-agent repo_name: Codium-ai/pr-agent nav: - Overview: - 'index.md' - - ๐Ÿ’Ž PR-Agent Pro: 'overview/pr_agent_pro.md' + - ๐Ÿ’Ž Qodo Merge Pro: 'overview/pr_agent_pro.md' - Data Privacy: 'overview/data_privacy.md' - Installation: - 'installation/index.md' @@ -14,7 +14,7 @@ nav: - GitLab: 'installation/gitlab.md' - BitBucket: 'installation/bitbucket.md' - Azure DevOps: 'installation/azure.md' - - ๐Ÿ’Ž PR-Agent Pro: 'installation/pr_agent_pro.md' + - ๐Ÿ’Ž Qodo Merge Pro: 'installation/pr_agent_pro.md' - Usage Guide: - 'usage-guide/index.md' - Introduction: 'usage-guide/introduction.md' @@ -23,7 +23,7 @@ nav: - Managing Mail Notifications: 'usage-guide/mail_notifications.md' - Changing a Model: 'usage-guide/changing_a_model.md' - Additional Configurations: 'usage-guide/additional_configurations.md' - - ๐Ÿ’Ž PR-Agent Pro Models: 'usage-guide/PR_agent_pro_models' + - ๐Ÿ’Ž Qodo Merge Pro Models: 'usage-guide/PR_agent_pro_models' - Tools: - 'tools/index.md' - Describe: 'tools/describe.md' @@ -53,7 +53,7 @@ nav: - Static code analysis: 'core-abilities/static_code_analysis.md' - Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md' - Chrome Extension: - - PR-Agent Chrome Extension: 'chrome-extension/index.md' + - Qodo Merge Chrome Extension: 'chrome-extension/index.md' - Features: 'chrome-extension/features.md' - Data Privacy: 'chrome-extension/data_privacy.md' - FAQ: