From 991109b0de29d1915b5f9913370a3af33667cfa9 Mon Sep 17 00:00:00 2001 From: Nick Busey Date: Tue, 19 Nov 2024 12:34:49 -0700 Subject: [PATCH 1/5] Flesh out knowledgebase a bit --- docs/about/features.md | 2 +- docs/integrations/knowledge-base.md | 30 +++++++++++++++++++++-------- 2 files changed, 23 insertions(+), 9 deletions(-) diff --git a/docs/about/features.md b/docs/about/features.md index 20345bc9..b1decf5d 100644 --- a/docs/about/features.md +++ b/docs/about/features.md @@ -83,7 +83,7 @@ changes. ![Irony in Committable Suggestions - CodeRabbit](/img/about/ironic-committable.png) -### 7. Learnings {#learnings} +### 7. [Learnings](/integrations/knowledge-base#learnings) {#learnings} - **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your repositories and organization. diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md index b41ed48c..2fd01ad3 100644 --- a/docs/integrations/knowledge-base.md +++ b/docs/integrations/knowledge-base.md @@ -1,36 +1,50 @@ --- -title: External Knowledge Base +title: Knowledge Base description: Integrate CodeRabbit with an external knowledge base for issue tracking. sidebar_label: Knowledge Base sidebar_position: 4 --- -CodeRabbit integrates with external knowledge bases to provide a seamless experience for issue tracking. This will allow CodeRabbit to use the context from the linked issues while reviewing the code. +CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience. -## Jira {#jira} +## Issues -### CodeRabbit App +The issues knowledge base allows CodeRabbit to use the context from linked and related issues while reviewing the code. + +### Jira {#jira} + +#### CodeRabbit App 1. Navigate to [integrations][integrations] in the CodeRabbit app. 2. Toggle the Jira switch to enable the integration. Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira login page. Enter your Jira credentials to authenticate the integration. -### CodeRabbit Configuration +#### CodeRabbit Configuration 1. Add Jira's Project Keys to the `knowledge_base.jira.project_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`. -## Linear {#Linear} +### Linear {#Linear} -### CodeRabbit App +#### CodeRabbit App 1. Navigate to [integrations][integrations] in the CodeRabbit app. 2. Toggle the Linear switch to enable the integration. Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear login page. Enter your Linear credentials to authenticate the integration. -### CodeRabbit Configuration +#### CodeRabbit Configuration 1. Add Linear's Team Keys to the `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`. [integrations]: https://app.coderabbit.ai/integrations + +## Learnings + +You can tell the bot to remember things about either specific lines in files, or generally about the entire repository, or even across repositories. + +## On-premises + +For self-hosted / on-premises deployments, you can enabled the knowledge base features by setting `ON_PREM_KNOWLEDGE_BASE` to true in the environment variables for your self-hosted docker image. + +By default CodeRabbit will store it's data in the `coderabbitai/data` branch unless you set `ON_PREM_KNOWLEDGE_BASE_BRANCH` with a different value. From 6a2222832346b31126545b1b8bed5f322eb6270c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 19 Nov 2024 19:36:47 +0000 Subject: [PATCH 2/5] =?UTF-8?q?=F0=9F=8E=A8=20pnpm=20run=20lint:fix?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [dependabot skip] --- docs/integrations/knowledge-base.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md index 2fd01ad3..e69af9ed 100644 --- a/docs/integrations/knowledge-base.md +++ b/docs/integrations/knowledge-base.md @@ -5,7 +5,7 @@ sidebar_label: Knowledge Base sidebar_position: 4 --- -CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience. +CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience. ## Issues From 79c8a529f216ef13e2847ca74e96d048d62236ff Mon Sep 17 00:00:00 2001 From: Nick Busey Date: Tue, 19 Nov 2024 12:44:18 -0700 Subject: [PATCH 3/5] Update docs/integrations/knowledge-base.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs/integrations/knowledge-base.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md index e69af9ed..c42b8926 100644 --- a/docs/integrations/knowledge-base.md +++ b/docs/integrations/knowledge-base.md @@ -1,6 +1,6 @@ --- title: Knowledge Base -description: Integrate CodeRabbit with an external knowledge base for issue tracking. +description: Learn about CodeRabbit's internal knowledge base and its integrations with external services. sidebar_label: Knowledge Base sidebar_position: 4 --- From 37b5354706b342f1ca0c8178ebb5b5f055967c30 Mon Sep 17 00:00:00 2001 From: Nick Busey Date: Tue, 19 Nov 2024 12:45:02 -0700 Subject: [PATCH 4/5] Update docs/integrations/knowledge-base.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs/integrations/knowledge-base.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md index c42b8926..ffb15419 100644 --- a/docs/integrations/knowledge-base.md +++ b/docs/integrations/knowledge-base.md @@ -45,6 +45,6 @@ You can tell the bot to remember things about either specific lines in files, or ## On-premises -For self-hosted / on-premises deployments, you can enabled the knowledge base features by setting `ON_PREM_KNOWLEDGE_BASE` to true in the environment variables for your self-hosted docker image. +For self-hosted / on-premises deployments, you can enable the knowledge base features by setting `ON_PREM_KNOWLEDGE_BASE=true` in the environment variables for your self-hosted docker image. -By default CodeRabbit will store it's data in the `coderabbitai/data` branch unless you set `ON_PREM_KNOWLEDGE_BASE_BRANCH` with a different value. +By default, CodeRabbit will store its data in the `coderabbitai/data` branch unless you set `ON_PREM_KNOWLEDGE_BASE_BRANCH=` with a different value. From ba86d7b7e23b5d792216424166c0c3750e49898e Mon Sep 17 00:00:00 2001 From: Nick Busey Date: Tue, 19 Nov 2024 12:47:52 -0700 Subject: [PATCH 5/5] Cleanup --- docs/integrations/knowledge-base.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md index ffb15419..68044757 100644 --- a/docs/integrations/knowledge-base.md +++ b/docs/integrations/knowledge-base.md @@ -39,10 +39,14 @@ Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear [integrations]: https://app.coderabbit.ai/integrations -## Learnings +## Learnings {#learnings} You can tell the bot to remember things about either specific lines in files, or generally about the entire repository, or even across repositories. +For example you can add a comment in a PR to chat directly with CodeRabbit. `@coderabbitai always remember to enforce camelCase`. + +Or you can comment directly on some lines of code in the PR. `@coderabbitai do not complain about lack of error handling here, it is handled higher up the execution stack.` + ## On-premises For self-hosted / on-premises deployments, you can enable the knowledge base features by setting `ON_PREM_KNOWLEDGE_BASE=true` in the environment variables for your self-hosted docker image.