Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Commit dd9403c

Browse files
Prasad BhatPrasad Bhat
Prasad Bhat
authored and
Prasad Bhat
committed
docs: add coderabbit to your repository section UI enhancements
1 parent de79b5b commit dd9403c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1942
-869
lines changed

‎docs/faq.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,16 @@ View step by step instructions depending on your platform:
3333

3434
<Tabs>
3535
<TabItem value="github" label="GitHub" default>
36-
See our [GitHub App installation guide](./platforms/github-com.md) for step-by-step instructions.
36+
See our [GitHub App installation guide](./platforms/github-com.mdx) for step-by-step instructions.
3737
</TabItem>
3838
<TabItem value="gitlab" label="GitLab">
3939
Follow our [GitLab integration guide](/platforms/gitlab-com.mdx) to get started.
4040
</TabItem>
4141
<TabItem value="bitbucket" label="Bitbucket">
42-
Check out the [Bitbucket installation steps](/platforms/bitbucket-cloud.md) for detailed setup.
42+
Check out the [Bitbucket installation steps](/platforms/bitbucket-cloud.mdx) for detailed setup.
4343
</TabItem>
4444
<TabItem value="azure" label="Azure DevOps">
45-
View our [Azure DevOps setup guide](/platforms/azure-devops.md) for complete installation instructions.
45+
View our [Azure DevOps setup guide](/platforms/azure-devops.mdx) for complete installation instructions.
4646
</TabItem>
4747
</Tabs>
4848

‎docs/getting-started/adding-organizations.md‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎docs/getting-started/adding-organizations.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Add organizations
3+
description: Learn how to add new organizations to CodeRabbit
4+
---
5+
6+
import InfoBox from "../../src/components/InfoBox"
7+
import ListItems from "../../src/components/ListItems"
8+
import Note from "../../src/components/Note"
9+
10+
To add new organizations to CodeRabbit, follow these steps:
11+
12+
<ListItems
13+
orderedList
14+
items={[
15+
<>Navigate to <a href="https://coderabbit.ai">coderabbit.ai</a></>,
16+
<>Click the "Refresh" button next to your organizations list to check for new organizations</>,
17+
<>Find the organization you want to add in the list</>,
18+
<>Click the "Grant" button next to the organization name</>
19+
]}
20+
/>
21+
22+
![Checking for new organizations](../../static/img/getting-started/check-for-new-orgs.png)
23+
24+
![Granting permission to organization](../../static/img/getting-started/grant-permission.png)
25+
26+
This will grant CodeRabbit access to the selected organization, allowing it to:
27+
28+
<ListItems
29+
items={[
30+
"Read organization and team membership",
31+
"Read organization projects",
32+
"Access user email addresses (read-only)"
33+
]}
34+
/>
35+
36+
<Note type="note">
37+
Organizations control which applications are allowed to access their private data. You may need organization admin approval to complete this process.
38+
</Note>
39+
40+
## What's next {#whats-next}
41+
42+
- [Manage your subscription](/getting-started/subscription-management)

‎docs/getting-started/quickstart.mdx‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import DarkCodeBlock from "../../src/components/DarkCodeBlock"
1111
import InfoBox from "../../src/components/InfoBox"
1212
import ListItems from "../../src/components/ListItems"
1313
import Note from "../../src/components/Note"
14+
import BlockQuote from "../../src/components/BlockQuote"
1415

1516
# Quickstart
1617

@@ -145,13 +146,13 @@ After CodeRabbit reviews a pull request, you can converse with it about its revi
145146

146147
After a few moments, CodeRabbit posts its reply, explaining its motivations for its recommendation. The reply might resemble the following:
147148

148-
<ChatBubble>
149-
{`You're right that these functions are quite self-explanatory from their names alone. Docstrings aren't strictly necessary for every function, especially in smaller projects with clear function names.
149+
<BlockQuote>
150+
You're right that these functions are quite self-explanatory from their names alone. Docstrings aren't strictly necessary for every function, especially in smaller projects with clear function names.
150151

151-
While docstrings do provide benefits (IDE tooltips, documentation generation, help for future developers), they can sometimes feel redundant for very straightforward functions. It's ultimately a matter of coding style and project requirements.
152+
While docstrings do provide benefits (IDE tooltips, documentation generation, help for future developers), they can sometimes feel redundant for very straightforward functions. It's ultimately a matter of coding style and project requirements.
152153

153-
If you prefer to skip docstrings for obvious utility functions in this project, that's perfectly reasonable. Would you like me to adjust my review approach regarding documentation for this repository?`}
154-
</ChatBubble>
154+
If you prefer to skip docstrings for obvious utility functions in this project, that's perfectly reasonable. Would you like me to adjust my review approach regarding documentation for this repository?
155+
</BlockQuote>
155156

156157
In this case, CodeRabbit is offering to adjust its future behavior when reviewing changes to this repository. Instead, follow the next step to ask CodeRabbit to implement part of its suggestions.
157158

‎docs/getting-started/upgrading-permissions.md‎ renamed to ‎docs/getting-started/upgrading-permissions.mdx‎

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,21 @@ title: Set permissions
33
description: Learn how to upgrade CodeRabbit's GitHub App permissions when new features are added
44
---
55

6+
import ListItems from "../../src/components/ListItems"
7+
import Note from "../../src/components/Note"
8+
69
Sometimes when we add new features to CodeRabbit, we need to request additional GitHub permissions. If you see a warning about permissions or resources not being accessible, you'll need to approve the new permissions. Here's how to do it:
710

8-
1. Navigate to your organization or repository settings in GitHub
9-
2. Go to the "GitHub Apps" or "Installed GitHub Apps" section
10-
3. Find CodeRabbit in the list of installed apps
11-
4. Click "Configure"
12-
5. Review and accept the new permissions
11+
<ListItems
12+
orderedList
13+
items={[
14+
<>Navigate to your organization or repository settings in GitHub</>,
15+
<>Go to the "GitHub Apps" or "Installed GitHub Apps" section</>,
16+
<>Find CodeRabbit in the list of installed apps</>,
17+
<>Click "Configure"</>,
18+
<>Review and accept the new permissions</>
19+
]}
20+
/>
1321

1422
![Permission warning example](../../static/img/getting-started/permission-warning.png)
1523

@@ -19,11 +27,17 @@ Sometimes when we add new features to CodeRabbit, we need to request additional
1927

2028
Common reasons for permission updates include:
2129

22-
- Access to new GitHub features
23-
- Enhanced repository scanning capabilities
24-
- Additional workflow automation features
25-
- Improved security features
30+
<ListItems
31+
items={[
32+
"Access to new GitHub features",
33+
"Enhanced repository scanning capabilities",
34+
"Additional workflow automation features",
35+
"Improved security features"
36+
]}
37+
/>
2638

27-
> Note: If you're not an organization admin, you may need to request approval from your organization administrators to update the permissions.
39+
<Note type="note">
40+
If you're not an organization admin, you may need to request approval from your organization administrators to update the permissions.
41+
</Note>
2842

29-
After accepting the new permissions, CodeRabbit will have the access it needs to function properly. If you continue to experience issues, try refreshing your browser or reaching out to our support team.
43+
After accepting the new permissions, CodeRabbit will have the access it needs to function properly. If you continue to experience issues, try refreshing your browser or reaching out to our support team.

‎docs/overview/why-coderabbit.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ CodeRabbit is built for production environments with:
348348
349349
### Three Steps to Better Code Reviews
350350

351-
1. **Sign in** with [GitHub](../platforms/github-com.md), [GitLab](../platforms/gitlab-com.mdx), or [Azure DevOps](../platforms/azure-devops.md)
351+
1. **Sign in** with [GitHub](../platforms/github-com.mdx), [GitLab](../platforms/gitlab-com.mdx), or [Azure DevOps](../platforms/azure-devops.mdx)
352352
2. Select and add repositories in CodeRabbit dashboard
353353
3. That's it. You're good to go.
354354

‎docs/platforms/azure-devops.md‎

Lines changed: 0 additions & 102 deletions
This file was deleted.

‎docs/platforms/azure-devops.mdx‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
title: Integrating CodeRabbit with Azure DevOps
3+
description: Learn how to integrate CodeRabbit with Azure DevOps.
4+
sidebar_label: Azure DevOps
5+
sidebar_position: 5
6+
---
7+
8+
import InfoBox from "../../src/components/InfoBox"
9+
import ListItems from "../../src/components/ListItems"
10+
import { Warning } from "../../src/components/Warning"
11+
12+
This guide will assist you in effectively integrating CodeRabbit with Azure DevOps.
13+
14+
## Prerequisites
15+
16+
<ListItems
17+
items={[
18+
"An active Azure DevOps account",
19+
"Use of organizational email addresses is required; personal email addresses are not supported for this integration"
20+
]}
21+
/>
22+
23+
## Integration Instructions
24+
25+
<ListItems
26+
orderedList
27+
items={[
28+
<>Log in to the CodeRabbitAI application</>,
29+
<>After logging in, you will be redirected to a page displaying Microsoft Apps consent requests. Please forward these requests to your administrator for approval.
30+
31+
<Warning>
32+
If you are an administrator, you may approve the applications directly. If not, please contact your administrator to request approval for the applications.
33+
</Warning>
34+
35+
<img src="/img/integrations/azure_apps_consent_page.png" alt="CodeRabbit admin consent page for Azure DevOps integration" style={{border: '1px solid #e0e0e0', borderRadius: '4px'}} /></>,
36+
<>Once your administrator has approved the applications, click "Continue"</>,
37+
<>You will be redirected to the "Onboarding" page, where you can select the organization you wish to integrate with</>,
38+
<>On the "Azure DevOps User" page, enter your Personal Access Token for Azure DevOps.
39+
40+
<img src="/img/integrations/azure_devops_user_page.png" alt="CodeRabbit azure devOps integration settings page" style={{border: '1px solid #e0e0e0', borderRadius: '4px'}} /></>,
41+
<>To install CodeRabbit on a repository, toggle the switch on the "Repositories" page</>
42+
]}
43+
/>
44+
45+
## How it works
46+
47+
For the CodeRabbit app to post reviews on merge requests, it needs to interact with the Azure DevOps API, which requires a Personal Access Token. This token can be generated by creating a Personal Access Token from one of your existing users.
48+
49+
You can create a new user in Azure DevOps and generate a Personal Access Token for that user, following [our recommendations](#recommendations).
50+
51+
## Azure DevOps Personal Access Tokens
52+
53+
To interact with the Azure DevOps API, a **Personal Access Token** is required. This token can be generated by creating a **Personal Access Token** from one of your existing users.
54+
55+
Upon first login to the application (immediately after the onboarding screen), you will need to add the Personal Access Token.
56+
57+
![CodeRabbit azure devOps integration modal](/img/integrations/azure_personal_access_token_add.png)
58+
59+
### Recommendations
60+
61+
<ListItems
62+
items={[
63+
<><strong>Create a dedicated user for CodeRabbit</strong> - This ensures the user is exclusively for CodeRabbit, allowing better access control</>,
64+
<><strong>Use "CodeRabbit" as the username</strong> - This makes the user easily recognizable for future reference</>,
65+
<><strong>Use a dedicated email address</strong> - This helps in easy identification and management</>,
66+
<><strong>Use the CodeRabbit logo as the profile picture</strong> - This further ensures easy recognition. You can download our logo from <a href="/img/integrations/logo.png">here</a></>
67+
]}
68+
/>
69+
70+
### Key Points to Remember
71+
72+
<ListItems
73+
items={[
74+
<>Personal access tokens have expiration dates. Ensure the expiration date covers the duration of your intended use of the CodeRabbit app</>,
75+
<>Code reviews will be attributed to the owner of the personal access token</>,
76+
<>If the personal access token expires, you can add a new one via the CodeRabbit UI:
77+
<ListItems
78+
nested
79+
items={[
80+
<>Navigate to the "AzureDevOps User" page in the sidebar</>,
81+
<>Add the new token and click save</>
82+
]}
83+
/></>
84+
]}
85+
/>
86+
87+
### Generating a Personal Access Token
88+
89+
Azure DevOps provides an option to generate a personal access token for a user. Follow these steps to generate the token:
90+
91+
<ListItems
92+
orderedList
93+
items={[
94+
<>Log in as the user intended for CodeRabbit reviews</>,
95+
<>Next to your avatar on the headers right side is a settings icon, click it</>,
96+
<>Choose "Personal Access Tokens"</>,
97+
<>Click "New Token"</>,
98+
<>Select the organization you want to use the token with or select "All accessible organizations"</>,
99+
<>Enter a name and an expiry date for the token</>,
100+
<>We need to have read & write access to "Work Items" & "Code" to post reviews on pull requests. If you are on the Pro tier also add "Build" access for pipeline failure remediation</>,
101+
<>Click "Create"</>
102+
]}
103+
/>
104+
105+
![CodeRabbit azure devOps personal access token creation form](/img/integrations/azure-access-token.png)

0 commit comments

Comments
 (0)