diff --git a/docs/docs/faq/index.md b/docs/docs/faq/index.md index dcd5df6b1..66f89c48c 100644 --- a/docs/docs/faq/index.md +++ b/docs/docs/faq/index.md @@ -1,6 +1,6 @@ # FAQ -??? note "Question: Can Qodo Merge serve as a substitute for a human reviewer?" +??? note "Q: Can Qodo Merge serve as a substitute for a human reviewer?" #### Answer:1 Qodo Merge is designed to assist, not replace, human reviewers. @@ -12,7 +12,7 @@ 1. Preserves user's original PR header 2. Places user's description above the AI-generated PR description - 3. Cannot approve PRs; approval remains reviewer's responsibility + 3. Won't approve PRs; approval remains reviewer's responsibility 4. The code suggestions are optional, and aim to: - Encourage self-review and self-reflection - Highlight potential bugs or oversights @@ -22,15 +22,15 @@ ___ -??? note "Question: I received an incorrect or irrelevant suggestion. Why?" +??? note "Q: I received an incorrect or irrelevant suggestion. Why?" #### Answer:2 - Modern AI models, like Claude 3.5 Sonnet and GPT-4, are improving rapidly but remain imperfect. Users should critically evaluate all suggestions rather than accepting them automatically. - - AI errors are rare, but possible. A main value from reviewing the code suggestions lies in their high probability of catching **mistakes or bugs made by the PR author**. We believe it's worth spending 30-60 seconds reviewing suggestions, even if some aren't relevant, as this practice can enhances code quality and prevent bugs in production. + - AI errors are rare, but possible. A main value from reviewing the code suggestions lies in their high probability of catching **mistakes or bugs made by the PR author**. We believe it's worth spending 30-60 seconds reviewing suggestions, even if some aren't relevant, as this practice can enhance code quality and prevent bugs in production. - - 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: + - The hierarchical structure of the suggestions is designed to help the user _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. @@ -40,14 +40,14 @@ ___ ___ -??? note "Question: How can I get more tailored suggestions?" +??? note "Q: How can I get more tailored suggestions?" #### Answer:3 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?" +??? note "Q: Will you store my code? Are you using my code to train models?" #### Answer:4 No. Qodo Merge strict privacy policy ensures that your code is not stored or used for training purposes. @@ -56,12 +56,35 @@ ___ ___ -??? note "Question: Can I use my own LLM keys with Qodo Merge?" +??? note "Q: Can I use my own LLM keys with Qodo Merge?" #### Answer:5 - When you self-host, you use your own keys. + When you self-host the [open-source](https://github.com/Codium-ai/pr-agent) version, you use your own 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. +___ + +??? note "Q: Can Qodo Merge review draft/offline PRs?" + #### Answer:5 + + Yes. While Qodo Merge won't automatically review draft PRs, you can still get feedback by manually requesting it through [online commenting](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#online-usage). + + For active PRs, you can customize the automatic feedback settings [here](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#qodo-merge-automatic-feedback) to match your team's workflow. +___ + +??? note "Q: Can the 'Review effort' feedback be calibrated or customized?" + #### Answer:5 + + Yes, you can customize review effort estimates using the `extra_instructions` configuration option (see [documentation](https://qodo-merge-docs.qodo.ai/tools/review/#configuration-options)). + + Example mapping: + + - Effort 1: < 30 minutes review time + - Effort 2: 30-60 minutes review time + - Effort 3: 60-90 minutes review time + - ... + + Note: The effort levels (1-5) are primarily meant for _comparative_ purposes, helping teams prioritize reviewing smaller PRs first. The actual review duration may vary, as the focus is on providing consistent relative effort estimates. ___