Skip to content

Commit 6f5f8e0

Browse files
committed
Update sidebar positions for integrations documentation
1 parent 9de8889 commit 6f5f8e0

File tree

8 files changed

+43
-5
lines changed

8 files changed

+43
-5
lines changed

docs/about/_category_.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: About
2-
position: 2
2+
sidebar_position: 2
33
collapsible: true
44
collapsed: true

docs/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: FAQs
33
sidebar_label: FAQs
44
description: Frequently asked questions about CodeRabbit.
5-
position: 7
5+
sidebar_position: 7
66
---
77

88
### General

docs/guides/_category_.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Guides
2-
position: 5
2+
sidebar_position: 5
33
collapsible: true
44
collapsed: true

docs/integrations/_category_.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Integrations
2-
position: 6
2+
sidebar_position: 6
33
collapsible: true
44
collapsed: true

docs/integrations/knowledge-base.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: External Knowledge Base
3+
description: Integrate CodeRabbit with an external knowledge base for issue tracking.
4+
sidebar_label: Knowledge Base
5+
sidebar_position: 3
6+
---
7+
8+
CodeRabbit integrates with external knowledge bases to provide a seamless experience for issue tracking. This guide will assist you in effectively integrating CodeRabbit with the following supported issue tracking tools.
9+
10+
## Jira {#jira}
11+
12+
### CodeRabbit App
13+
14+
1. Navigate to [integrations][integrations] in the CodeRabbit app.
15+
2. Toggle the Jira switch to enable the integration.
16+
17+
Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira login page. Enter your Jira credentials to authenticate the integration.
18+
19+
### CodeRabbit Configuration
20+
21+
1. Add Jira's Project Keys to `knowledge_base.jira.project_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.
22+
23+
## Linear {#Linear}
24+
25+
### CodeRabbit App
26+
27+
1. Navigate to [integrations][integrations] in the CodeRabbit app.
28+
2. Toggle the Linear switch to enable the integration.
29+
30+
Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear login page. Enter your Linear credentials to authenticate the integration.
31+
32+
### CodeRabbit Configuration
33+
34+
1. Add Linear's Team Keys to `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.
35+
36+
[integrations]: https://app.coderabbit.ai/integrations

docs/integrations/saas-gitlab.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Integrating CodeRabbit with SaaS GitLab
33
description: Integrate CodeRabbit with SaaS GitLab.
44
sidebar_label: SaaS GitLab
5+
sidebar_position: 1
56
---
67

78
This guide will assist you in effectively integrating CodeRabbit with SaaS GitLab.

docs/integrations/self-hosted-gitlab.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: CodeRabbit for Self-Managed GitLab
33
description: Integrate CodeRabbit with your Self-Managed GitLab instance.
44
sidebar_label: Self-Managed GitLab
5+
sidebar_position: 2
56
---
67

78
This page guides you through the process of integrating your Self-Managed GitLab

docs/tools/_category_.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Supported Tools
2-
position: 4
2+
sidebar_position: 4
33
collapsible: true
44
collapsed: true

0 commit comments

Comments
 (0)