Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Improve Documentation Structure and Accessibility in Markdown Files#69

Merged
hasit merged 9 commits intomainfromhasit/docs-cleanup
Jul 20, 2024
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletionsdocs/about/features.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,28 +13,28 @@ High-Level Summary: This offers a concise overview of the changes in the pull
request. It helps the team, including those without technical expertise, to
quickly understand the changes and the impact on the product.

![Summary Overview](./images/Summary-Overview.png)
![Summary Overview](/img/about/Summary-Overview.png)

Walkthrough: A detailed code walkthrough to understand the changes in each file
that is part of the pull request, followed by a celebratory poem about the
changes.

![Summary Walkthrough](./images/Summary-Walkthrough.png)
![Summary Walkthrough](/img/about/Summary-Walkthrough.png)

### 2. Code Review feedback {#code-review-feedback}

Review feedback is posted as review comments on the lines of the code that
changed for each file. Code suggestions are given in a Diff format, which either
be copied or committed within the pull request with a single click.

![Review Feedback](./images/ReviewFeedback.png)
![Review Feedback](/img/about/ReviewFeedback.png)

A review status is generated for each commit that is reviewed. It displays the
commit IDs that were reviewed, the files examined and ignored, as well as the
additional comments generated for each review, and so on. Review status is
useful for understanding the auxiliary context of the review.

![Review Status](./images/ReviewStatus.png)
![Review Status](/img/about/ReviewStatus.png)

### 3. Chat with CodeRabbit {#chat-with-coderabbit}

Expand All@@ -44,11 +44,11 @@ changes. Just comment on the CodeRabbit review to start the conversation.
CodeRabbit learns from your interactions and gets smarter over time. The more
you chat, the better it gets.

![Chat](./images/chat.png)
![Chat](/img/about/chat.png)

### 4. Issue Validation {#issue-validation}

Pull request changes are validated against the linked GitHub or GitLab issue and
identifies all other issues which might be affected by this change.

![Issue Validation](./images/issue-validation.png)
![Issue Validation](/img/about/issue-validation.png)
Binary file removeddocs/about/images/CodeRabbitFlow.png
View file
Open in desktop
Binary file not shown.
8 changes: 4 additions & 4 deletionsdocs/about/pricing.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,15 +74,15 @@ These are the hourly usage limits for each developer per repository:
- During the trial period, seat assignment is automatic, but the number of seats
can be adjusted when purchasing the subscription.

![Seat Management](./images/cr_seat_manage_dark.png#gh-dark-mode-only)
![Seat Management](./images/cr_seat_manage_light.png#gh-light-mode-only)
![Seat Management](/img/about/cr_seat_manage_dark.png#gh-dark-mode-only)
![Seat Management](/img/about/cr_seat_manage_light.png#gh-light-mode-only)

### Free Plan

- Seats are assigned to new developers immediately

![Free Seat Assignment](./images/cr_seat_free_dark.png#gh-dark-mode-only)
![Free Seat Assignment](./images/cr_seat_free_light.png#gh-light-mode-only)
![Free Seat Assignment](/img/about/cr_seat_free_dark.png#gh-dark-mode-only)
![Free Seat Assignment](/img/about/cr_seat_free_light.png#gh-light-mode-only)

**Note:** The subscription is limited to human users; bot users are not
supported. Thus, pull requests or merge requests created by bots will not be
Expand Down
6 changes: 3 additions & 3 deletionsdocs/about/support.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,8 +22,8 @@ Complete the support ticket by providing your name, email, a description of your
issue, and attaching any necessary files. If you are reporting a bug, please
provide the GitHub or GitLab organization name.

![Open a Ticket](./images/cr_support_help_light.png#gh-light-mode-only)
![Open a Ticket](./images/cr_support_help_dark.png#gh-dark-mode-only)
![Open a Ticket](/img/about/cr_support_help_light.png#gh-light-mode-only)
![Open a Ticket](/img/about/cr_support_help_dark.png#gh-dark-mode-only)

## Email Support

Expand All@@ -33,7 +33,7 @@ You can also reach out to us at
:::tip

To see more common issues faced by CodeRabbit users, visit our
[FAQ section](../faq/faq.md) for detailed answers and solutions to frequently
[FAQ section](../faq.md) for detailed answers and solutions to frequently
encountered problems.

:::
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ description:
CodeRabbit offers various configuration options to tailor the reviews to your
specific requirements. Configuration can be made using one of the below
options.
sidebar_position:1
sidebar_position:3
---

```mdx-code-block
Expand Down
29 changes: 24 additions & 5 deletionsdocs/faq/faq.md → docs/faq.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@
title: FAQs
sidebar_label: FAQs
description: Frequently asked questions about CodeRabbit.
sidebar_position: 7
---

### General
Expand DownExpand Up@@ -37,15 +38,33 @@ uses proprietary code from private repositories for training purposes.
Yes, you can switch between different organizations on CodeRabbit. To do so,
click on the organization name in the top-left corner of the CodeRabbit UI.

![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)
![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)
![Switch Organizations](/img/faq/cr_support_orgs_light.png#gh-light-mode-only)
![Switch Organizations](/img/faq/cr_support_orgs_dark.png#gh-dark-mode-only)

#### What Large Language Models does CodeRabbit use?

CodeRabbit currently utilizes OpenAI's `gpt-4-turbo` and `gpt-3.5-turbo`. We're
researching and testing upcoming LLMs to ensure we're offering the most precise
reviews possible.

#### How does CodeRabbit compare to other AI code generators?

Code reviews remain essential, whether the code is written by a human or a bot.
This is mainly because the perspective of the reviewer differs from that of the
code generator, whether human or machine. This distinction is precisely why
human peer reviews have been effective for so long. While AI-powered
code-generation tools like GitHub Copilot hold immense potential, it's important to recognize that
these generators are still in their early stages and may not be equipped to
auto-generate meaningful code for moderately complex applications.

#### How is CodeRabbit different from other code review tools?

Traditional code review tools excel in linting and static analysis, but they
fall short in providing context-aware, conversational feedback with actionable
suggestions for changes that can be directly committed. On the other hand,
**CodeRabbit** leverages AI to understand the intent behind the code changes and
provide human-like feedback for applying the best practices.

### Subscription

#### Can a CodeRabbit subscription be used across multiple organizations?
Expand DownExpand Up@@ -74,7 +93,7 @@ commit after the app is installed. You can, however, use the
#### Can I customize CodeRabbit?

Reviews are customizable. For information, check out our
[Customization](../guides/review-instructions.md) guide.
[Customization](./guides/review-instructions.md) guide.

#### Can I choose a language other than English for the reviews?

Expand DownExpand Up@@ -123,7 +142,7 @@ cases, we re-allow further reviews/conversations after a brief timeout.

#### Who can install CodeRabbit on the repositories?

You need to be an admin of theorgnizaation to add the repositories.
You need to be an admin of theorganization to add the repositories.

#### I can't add CodeRabbit to my GitLab Repositories. What should I do?

Expand All@@ -133,6 +152,6 @@ If there are any access restrictions by domain, then you will need to add
:::tip

If you have further questions or need additional information, please check out
our [Support](../about/support.md) page for more details.
our [Support](./about/support.md) page for more details.

:::
2 changes: 1 addition & 1 deletiondocs/guides/_category_.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
label: Guides
position:3
position:5
collapsible: true
collapsed: true
4 changes: 2 additions & 2 deletionsdocs/guides/delete-account.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,8 +43,8 @@ upon selecting **Delete Account**. You can open the dropdowns for more
information.

<div align="center">
![Delete Account](./images/delete_account_light.png#gh-light-mode-only)
![Delete Account](./images/delete_account_dark.png#gh-dark-mode-only)
![Delete Account](/img/guides/delete_account_light.png#gh-light-mode-only)
![Delete Account](/img/guides/delete_account_dark.png#gh-dark-mode-only)
</div>

Deletion will only occur once the admin specifically types in "delete" in the
Expand Down
2 changes: 1 addition & 1 deletiondocs/guides/ondemand-reports.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ Sign in to your CodeRabbit account and navigate to the [**API Keys**](https://ap
Click on the **Create API Key** button and enter a name for the API Key.
Copy the API key, and keep it safe as it won't be visible again.

![API Keys](./images/api_keys.png)
![API Keys](/img/guides/api_keys.png)

## Generate an On-demand report

Expand Down
2 changes: 1 addition & 1 deletiondocs/guides/review-instructions.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ sidebar_position: 3
---

The guide explains how to add custom review instructions for the entire project.
Also, see the guide on how to [configure CodeRabbit](./configure-coderabbit.md).
Also, see the guide on how to [configure CodeRabbit](../configure-coderabbit.md).

### Path-based instructions {#path-based}

Expand Down
4 changes: 0 additions & 4 deletionsdocs/guides/tools/_category_.yml
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletiondocs/integrations/_category_.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
label: Integrations
position:4
position:6
collapsible: true
collapsed: true
36 changes: 36 additions & 0 deletionsdocs/integrations/knowledge-base.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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 will allow CodeRabbit to use the context from the linked 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

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}

### 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 the `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.

[integrations]: https://app.coderabbit.ai/integrations
11 changes: 6 additions & 5 deletionsdocs/integrations/saas-gitlab.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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 All@@ -26,22 +27,22 @@ To interact with the GitLab API, a **Personal Access Token** is required. This t

Upon first login to the application (immediately after the onboarding screen), you will need to choose based on your organization's requirements.

![gitlab user modal choice](./images/gitlab_user_choice.png)
![gitlab user modal choice](/img/integrations/gitlab_user_choice.png)

**We recommend using the default CodeRabbit user** for most organizations as it is pre-configured. However, we understand that some organizations may prefer more control over the user or have restrictions regarding user inclusion within their organization.
**We recommend using the default CodeRabbit user** for most organizations, as it is pre-configured. However, we understand that some organizations may prefer more control over the user or have restrictions regarding user inclusion within their organization.

### Personal Access Tokens

If your organization opts to use another user within the organization, you can do so by [generating a personal access token](#generating-a-personal-access-token).

![gitlab organization user modal choice](./images/gitlab_organization_user.png)
![gitlab organization user modal choice](/img/integrations/gitlab_organization_user.png)

#### Recommendations

* **Create a dedicated user for CodeRabbit** - This ensures the user is exclusively for CodeRabbit, allowing better access control.
* **Use "CodeRabbit" as the username** - This makes the user easily recognizable for future reference.
* **Use a dedicated email address** - This helps in easy identification and management.
* **Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from [here](./images/logo.svg "download").
* **Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from [here](/img/integrations/logo.svg "download").

#### Key Points to Remember

Expand All@@ -66,4 +67,4 @@ GitLab provides an option to generate a personal access token for a new user. Fo
9. Click "Create Personal Access Token."
10. Note down the token as it will only be displayed once.

![Untitled](./images/admin-access-token.png)
![Untitled](/img/integrations/admin-access-token.png)
13 changes: 7 additions & 6 deletionsdocs/integrations/self-hosted-gitlab.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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 All@@ -16,23 +17,23 @@ complete, you can log in directly using the OAuth2 flow.
**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
select Self-Hosted GitLab

![login-page](./images/login-page.png)
![login-page](/img/integrations/login-page.png)

### Step 2: Enter your Self-Managed GitLab URL

On this page, enter the URL of your self-managed GitLab instance and click
submit. Once, you submit, we check our database for a record of your
organization and if we find an existing one, we are starting the login process.

![Untitled](./images/self-hosted-gitlab-host-url.png)
![Untitled](/img/integrations/self-hosted-gitlab-host-url.png)

If the self-managed GitLab instance is not found, we initiate the onboarding process, which can be either manual or automated.

### **Step 3: Onboarding Manual or Automated**

#### 1. Automated onboarding

![Untitled](./images/automated-onboarding.png)
![Untitled](/img/integrations/automated-onboarding.png)

#### **Why do we need the Admin Access Token?**

Expand All@@ -47,7 +48,7 @@ wish, as the next step.
#### 2. Manual onboarding

For the manual onboarding process we need to create the [CodeRabbit user](#creating-coderabbit-user) and the [OAuth2 GitLab application](#creating-oauth2-application).
![Untitled](./images/manual-onboarding.png)
![Untitled](/img/integrations/manual-onboarding.png)

#### **Creating CodeRabbit user**

Expand DownExpand Up@@ -89,14 +90,14 @@ the token, please follow the process outlined below:
9. Select Create personal access token.
10. Please note down this token as this will be visible one time only

![Untitled](./images/admin-access-token.png)
![Untitled](/img/integrations/admin-access-token.png)

### **Step 4: Paste the details and click submit**

- Submit the form.
- We will handle the setup process for you.
- On subsequent visits, your setup will be automatically detected, allowing for
direct login. ![Untitled](./images/self-hosted-page.png)
direct login. ![Untitled](/img/integrations/self-hosted-page.png)

### **Step 5: Whitelist CodeRabbit IP address**

Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp