Merge pull request #1220 from Codium-ai/tr/updates_and_fixes

FAQ

docs/docs/core-abilities/index.md

@@ -8,4 +8,5 @@ PR-Agent utilizes a variety of core abilities to provide a comprehensive and eff
 - [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/)
+- [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/)

docs/docs/faq/index.md

@@ -0,0 +1,59 @@
+# FAQ
+
+??? note "Question: Can PR-Agent serve as a substitute for human code review?"
+    #### Answer:<span style="display:none;">1</span>
+
+    PR-Agent 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.
+
+    However, PR-Agent 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
+    3. Cannot 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
+        - Enhance code quality and promote best practices
+
+    Read more about this issue in our [blog](https://www.codium.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)
+
+
+
+??? note "Question: I received an incorrect or irrelevant suggestion. Why?"
+
+    #### Answer:<span style="display:none;">2</span>
+
+    - 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.
+
+
+    - 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.
+
+??? note "Question: How can I get more tailored suggestions?"
+    #### Answer:<span style="display:none;">3</span>
+
+    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.
+
+??? note "Question: Will you store my code ? Are you using my code to train models?"
+    #### Answer:<span style="display:none;">4</span>
+
+    No. PR-Agent 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/)
+
+??? note "Question: Can I use my own LLM keys with PR-Agent?"
+    #### Answer:<span style="display:none;">5</span>
+
+    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.
+    For enterprise customers, on-prem deployment is also available. [Contact us](https://www.codium.ai/contact/#pricing) for more information.

docs/mkdocs.yml

@@ -51,11 +51,13 @@ nav:
       - Compression strategy: 'core-abilities/compression_strategy.md'
       - Code-oriented YAML: 'core-abilities/code_oriented_yaml.md'
       - 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'
       - Features: 'chrome-extension/features.md'
       - Data Privacy: 'chrome-extension/data_privacy.md'
-  - Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md'
+  - FAQ
+#  - Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md'
 
 theme:
   logo: assets/logo.svg