Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
Prev Previous commit
Next Next commit
Update sidebar positions for integrations documentation
  • Loading branch information
hasit committed Jul 20, 2024
commit 6f5f8e094cca0a42d7ea9720056ce41605cf1f5c
2 changes: 1 addition & 1 deletion docs/about/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
label: About
position: 2
sidebar_position: 2
collapsible: true
collapsed: true
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: FAQs
sidebar_label: FAQs
description: Frequently asked questions about CodeRabbit.
position: 7
sidebar_position: 7
---

### General
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
label: Guides
position: 5
sidebar_position: 5
collapsible: true
collapsed: true
2 changes: 1 addition & 1 deletion docs/integrations/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
label: Integrations
position: 6
sidebar_position: 6
collapsible: true
collapsed: true
36 changes: 36 additions & 0 deletions docs/integrations/knowledge-base.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: External Knowledge Base
description: Integrate CodeRabbit with an external knowledge base for issue tracking.
sidebar_label: Knowledge Base
sidebar_position: 3
---

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.

## 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

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

## Linear {#Linear}

### 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

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

[integrations]: https://app.coderabbit.ai/integrations
1 change: 1 addition & 0 deletions docs/integrations/saas-gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Integrating CodeRabbit with SaaS GitLab
description: Integrate CodeRabbit with SaaS GitLab.
sidebar_label: SaaS GitLab
sidebar_position: 1
---

This guide will assist you in effectively integrating CodeRabbit with SaaS GitLab.
Expand Down
1 change: 1 addition & 0 deletions docs/integrations/self-hosted-gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: CodeRabbit for Self-Managed GitLab
description: Integrate CodeRabbit with your Self-Managed GitLab instance.
sidebar_label: Self-Managed GitLab
sidebar_position: 2
---

This page guides you through the process of integrating your Self-Managed GitLab
Expand Down
2 changes: 1 addition & 1 deletion docs/tools/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
label: Supported Tools
position: 4
sidebar_position: 4
collapsible: true
collapsed: true