From 6755823ba0771bab4dbfe5ecbdf8b6e4d1d4cc25 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Mon, 15 Jul 2024 15:07:14 -0700 Subject: [PATCH] Update introduction.md and add video --- docs/{introduction => }/introduction.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) rename docs/{introduction => }/introduction.md (87%) diff --git a/docs/introduction/introduction.md b/docs/introduction.md similarity index 87% rename from docs/introduction/introduction.md rename to docs/introduction.md index 8d3c2b57..6b257519 100644 --- a/docs/introduction/introduction.md +++ b/docs/introduction.md @@ -23,6 +23,8 @@ performing continuous, incremental reviews for each commit within a pull request. Review feedback is sent back to the pull requests and can be directly committed. + + ### How does CodeRabbit work? **CodeRabbit** integrates into code repositories using GitHub or GitLab webhooks @@ -31,7 +33,7 @@ A comprehensive review is performed when a PR or MR is created, and for incremental commits and comments addressed to the bot. The feedback is then sent directly back to the PR or MR. -![CodeRabbit Flow](../about/images/CodeRabbitFlow.png) +![CodeRabbit Flow](about/images/CodeRabbitFlow.png) ### Data, Privacy, and Security @@ -40,11 +42,11 @@ influence the models. Queries to the Large Language Models (LLMs) are ephemeral and there is zero retention on LLMs. Neither we nor the LLMs provider(s) share any data collected during the code review process with third parties. -Data storage: Code downloaded during the review process is temporarily stored in -memory and deleted once the review is completed. The code is not stored or used for -any other purpose. However, CodeRabbit enhances future reviews for your organization by -storing the embeddings of the learnings generated from chat conversations. Additionally, -it integrates embeddings from issues in workflow systems (Liner, Jira, GitHub/GitLab issues) +Data storage: Code downloaded during the review process is temporarily stored in +memory and deleted once the review is completed. The code is not stored or used for +any other purpose. However, CodeRabbit enhances future reviews for your organization by +storing the embeddings of the learnings generated from chat conversations. Additionally, +it integrates embeddings from issues in workflow systems (Liner, Jira, GitHub/GitLab issues) to assess the impact of code changes on existing issues. Compliance and Data Privacy: Your data is kept confidential, isolated by the