Skip to content

Commit 8d29d4d

Browse files
NickBuseygithub-actions[bot]coderabbitai[bot]
authored
Flesh out knowledgebase docs a bit (#150)
* Flesh out knowledgebase a bit * 🎨 pnpm run lint:fix [dependabot skip] * Update docs/integrations/knowledge-base.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update docs/integrations/knowledge-base.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Cleanup --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent 4ab715f commit 8d29d4d

File tree

2 files changed

+28
-10
lines changed

2 files changed

+28
-10
lines changed

docs/about/features.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ changes.
8383

8484
![Irony in Committable Suggestions - CodeRabbit](/img/about/ironic-committable.png)
8585

86-
### 7. Learnings {#learnings}
86+
### 7. [Learnings](/integrations/knowledge-base#learnings) {#learnings}
8787

8888
- **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your
8989
repositories and organization.

docs/integrations/knowledge-base.md

+27-9
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,54 @@
11
---
2-
title: External Knowledge Base
3-
description: Integrate CodeRabbit with an external knowledge base for issue tracking.
2+
title: Knowledge Base
3+
description: Learn about CodeRabbit's internal knowledge base and its integrations with external services.
44
sidebar_label: Knowledge Base
55
sidebar_position: 4
66
---
77

8-
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.
8+
CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience.
99

10-
## Jira {#jira}
10+
## Issues
1111

12-
### CodeRabbit App
12+
The issues knowledge base allows CodeRabbit to use the context from linked and related issues while reviewing the code.
13+
14+
### Jira {#jira}
15+
16+
#### CodeRabbit App
1317

1418
1. Navigate to [integrations][integrations] in the CodeRabbit app.
1519
2. Toggle the Jira switch to enable the integration.
1620

1721
Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira login page. Enter your Jira credentials to authenticate the integration.
1822

19-
### CodeRabbit Configuration
23+
#### CodeRabbit Configuration
2024

2125
1. Add Jira's Project Keys to the `knowledge_base.jira.project_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.
2226

23-
## Linear {#Linear}
27+
### Linear {#Linear}
2428

25-
### CodeRabbit App
29+
#### CodeRabbit App
2630

2731
1. Navigate to [integrations][integrations] in the CodeRabbit app.
2832
2. Toggle the Linear switch to enable the integration.
2933

3034
Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear login page. Enter your Linear credentials to authenticate the integration.
3135

32-
### CodeRabbit Configuration
36+
#### CodeRabbit Configuration
3337

3438
1. Add Linear's Team Keys to the `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.
3539

3640
[integrations]: https://app.coderabbit.ai/integrations
41+
42+
## Learnings {#learnings}
43+
44+
You can tell the bot to remember things about either specific lines in files, or generally about the entire repository, or even across repositories.
45+
46+
For example you can add a comment in a PR to chat directly with CodeRabbit. `@coderabbitai always remember to enforce camelCase`.
47+
48+
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.`
49+
50+
## On-premises
51+
52+
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.
53+
54+
By default, CodeRabbit will store its data in the `coderabbitai/data` branch unless you set `ON_PREM_KNOWLEDGE_BASE_BRANCH=<branch_name>` with a different value.

0 commit comments

Comments
 (0)