diff --git a/docs/docs/faq/index.md b/docs/docs/faq/index.md index b30c13fb..e4582cb8 100644 --- a/docs/docs/faq/index.md +++ b/docs/docs/faq/index.md @@ -1,7 +1,7 @@ # FAQ ??? note "Question: Can PR-Agent serve as a substitute for human code review?" - ### Answer:1 + #### Answer:1 PR-Agent is designed to assist, not replace, human reviewers. @@ -24,7 +24,7 @@ ??? note "Question: I received an incorrect or irrelevant suggestion. Why?" - ### Answer:2 + #### 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. @@ -39,19 +39,19 @@ - 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:3 + #### 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. ??? note "Question: Will you store my code ? Are you using my code to train models?" - ### Answer:4 + #### Answer:4 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:5 + #### Answer:5 When you self-host, you use your own keys.