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 Sep 4, 2025. It is now read-only.

Commita5adb95

Browse files
committed
restructure existing docs
1 parent2cbb989 commita5adb95

File tree

12 files changed

+437
-425
lines changed

12 files changed

+437
-425
lines changed

‎docs/about/features.md‎

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,60 @@
11
---
22
title:CodeRabbit in Action
33
sidebar_label:CodeRabbit in Action
4-
description:Accelerate Code Reviews with AI
5-
image:"/preview_meta.jpg"
4+
description:Learn how CodeRabbit works in a pull request review.
65
---
76

8-
<head>
9-
<metacharSet="utf-8" />
10-
<metaname="title"content="CodeRabbit: AI-powered Code Reviews" />
11-
<metaname="description"content="Accelerate Code Reviews with AI" />
7+
###1. Pull Request Summary {#pull-request-summary}
128

13-
<metaproperty="og:type"content="website" />
14-
<metaproperty="og:url"content="https://coderabbit.ai/" />
15-
<metaproperty="og:title"content="CodeRabbit: AI-powered Code Reviews" />
16-
<metaproperty="og:description"content="Accelerate Code Reviews with AI" />
17-
<metaproperty="og:image"content="/preview_meta.jpg" />
9+
Generated upon the creation of a pull request and subsequently updated with each
10+
incremental request.
1811

19-
<metaname="twitter:image"content="https://coderabbit.ai/preview_meta.jpg" />
20-
<metaname="twitter:card"content="summary_large_image" />
21-
<metaname="twitter:title"content="CodeRabbit: AI-powered Code Reviews" />
22-
<metaname="twitter:description"content="Accelerate Code Reviews with AI" />
23-
</head>
12+
High-Level Summary: This offers a concise overview of the changes in the pull
13+
request. It helps the team, including those without technical expertise, to
14+
quickly understand the changes and the impact on the product.
2415

25-
###1. Pull Request Summary[](https://coderabbit.ai/docs/coderabbit-in-action#pull-request-summary)
16+
![Summary Overview](./images/Summary-Overview.png)
2617

27-
Generated upon the creation of a pull request and subsequently updated with each incremental request.
18+
Walkthrough: A detailed code walkthrough to understand the changes in each file
19+
that is part of the pull request, followed by a celebratory poem about the
20+
changes.
2821

29-
High-LevelSummary: 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.
22+
![Summary Walkthrough](./images/Summary-Walkthrough.png)
3023

31-
![](./images/Summary-Overview.png)
24+
###2. Code Review feedback {#code-review-feedback}
3225

33-
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.
26+
Review comments: Review feedback posts as pull request, review comments on the
27+
lines of the code that changed under each file. Any code suggestions are given
28+
in a Diff format, which either be copied or committed within the pull request
29+
with a single click.
3430

35-
![](./images/Summary-Walkthrough.png)
31+
![Review Feedback](./images/ReviewFeedback.png)
3632

37-
###2. Code Review feedback[](https://coderabbit.ai/docs/coderabbit-in-action#code-review-feedback)
33+
###3. Chat with CodeRabbit {#chat-with-coderabbit}
3834

39-
Review comments: Review feedback posts as pull request review comments on the lines of the code that changed under each file. Any code suggestions are given in a Diff format which either be copied or committed within the pull request with a single click.
35+
CodeRabbit provides conversational capability that allows developers and the
36+
reviewers to ask questions, generate code, and get feedback in the context of
37+
changes. Just comment on the CodeRabbit review to start the conversation.
38+
CodeRabbit learns from your interactions and gets smarter over time. The more
39+
you chat, the better it gets.
4040

41-
![](./images/ReviewFeedback.png)
41+
![Chat](./images/chat.png)
4242

43-
###3. Chat with CodeRabbit[](https://coderabbit.ai/docs/coderabbit-in-action#chat-with-coderabbit)
43+
###4. Issue Validation {#issue-validation}
4444

45-
CodeRabbit provides conversational capability that allows developers and the reviewers to ask questions, generate code, and get feedback in the context of 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.
45+
Pull request changes are validated against the linked GitHub or GitLab issue and
46+
identifies all other issues which might be affected by this change.
4647

47-
![](./images/chat.png)
48+
![Issue Validation](./images/issue-validation.png)
4849

49-
###4. Issue Validation[](https://coderabbit.ai/docs/coderabbit-in-action#issue-validation)
50+
###5. Pull Request review status {#pull-request-review-status}
5051

51-
Pull request changes are validated against the linked GitHub or GitLab issue and identifies all other issues which might be effected by this change.
52+
Review status is generated for each review, including a separate one for each
53+
incremental commit. Displays the commit IDs that were reviewed, the files
54+
examined and ignored, as well as the actionable feedback and additional comments
55+
generated for each review.
5256

53-
![](./images/issue-validation.png)
57+
![Review Status](./images/ReviewStatus.png)
5458

55-
###5. Pull Request review status[](https://coderabbit.ai/docs/coderabbit-in-action#pull-request-summary-1)
56-
57-
Review status is generated for each review including a separate one for each incremental commit. Displays the commit IDs that were reviewed, the files examined and ignored, as well as the actionable feedback and additional comments generated for each review.
58-
59-
![](./images/ReviewStatus.png)
60-
61-
For information on how to get started with CodeRabbit, visit the [Get Started page](/get-started/signup)
59+
For information on how to get started with CodeRabbit, visit
60+
the [Get Started page](/get-started/signup)

‎docs/about/pricing.md‎

Lines changed: 25 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,25 @@
11
---
22
title:Plans
33
sidebar_label:Plans
4-
description:Accelerate Code Reviews with AI
5-
image:"/preview_meta.jpg"
4+
description:
5+
Learn about the plans, pricing, and subscription management of CodeRabbit.
66
---
77

8-
<head>
9-
<metacharSet="utf-8" />
10-
<metaname="title"content="CodeRabbit: AI-powered Code Reviews" />
11-
<metaname="description"content="Accelerate Code Reviews with AI" />
12-
13-
<metaproperty="og:type"content="website" />
14-
<metaproperty="og:url"content="https://coderabbit.ai/" />
15-
<metaproperty="og:title"content="CodeRabbit: AI-powered Code Reviews" />
16-
<metaproperty="og:description"content="Accelerate Code Reviews with AI" />
17-
<metaproperty="og:image"content="/preview_meta.jpg" />
18-
19-
<metaname="twitter:image"content="https://coderabbit.ai/preview_meta.jpg" />
20-
<metaname="twitter:card"content="summary_large_image" />
21-
<metaname="twitter:title"content="CodeRabbit: AI-powered Code Reviews" />
22-
<metaname="twitter:description"content="Accelerate Code Reviews with AI" />
23-
</head>
24-
25-
This section covers the plans, pricing, and subscription management of CodeRabbit.
8+
This section covers the plans, pricing, and subscription management of
9+
CodeRabbit.
2610

2711
##**Understanding Your Options**
2812

29-
-**Transparent Pricing**: CodeRabbit offers a per-seat pricing model that scales with your team size, ensuring you pay for what you need.
30-
-**7-Day Free Trial**: All plans start with a generous 7-day free trial for CodeRabbit Pro for the entire organization, ensuring a commitment-free experience
31-
-**No Credit Card Required**: You won't need a credit card to start your free trial.
32-
-**CodeRabbit Seats**
33-
Every developer who submits a pull request is counted as a separate seat. Seats can be purchased for all or for a limited number of developers.
13+
-**Transparent Pricing**: CodeRabbit offers a per-seat pricing model that
14+
scales with your team size, ensuring you pay for what you need.
15+
-**7-Day Free Trial**: All plans start with a generous 7-day free trial for
16+
CodeRabbit Pro for the entire organization, ensuring a commitment-free
17+
experience
18+
-**No Credit Card Required**: You won't need a credit card to start your free
19+
trial.
20+
-**CodeRabbit Seats** Every developer who submits a pull request is counted as
21+
a separate seat. Seats can be purchased for all or for a limited number of
22+
developers.
3423

3524
---
3625

@@ -68,7 +57,7 @@ These are the hourly usage limits for each developer per repository:
6857
###Features
6958

7059
- Starts with a 7-day free trial of the Pro plan.
71-
-unlimited accesson both public and private repositories.
60+
-Unlimited accessfor both public and private repositories.
7261
- Summarization pull requests on private repositories.
7362
- Reviews pull requests on public repositories.
7463

@@ -86,16 +75,19 @@ These are the hourly usage limits for each developer per repository:
8675

8776
###Pro Plan
8877

89-
- GitHub/GitLab organization owners can purchase or make changes to the subscription.
90-
- You can choose to manually purchase seats and assign them to developers, or have them assigned automatically as developers create pull requests.
91-
- During the trial period, seat assignment is automatic, but the number of seats can be adjusted when purchasing the subscription.
78+
- GitHub/GitLab organization owners can purchase or introduce changes to the
79+
subscription.
80+
- You can choose to manually purchase seats and assign them to developers, or
81+
have them assigned automatically as developers create pull requests.
82+
- During the trial period, seat assignment is automatic, but the number of seats
83+
can be adjusted when purchasing the subscription.
9284

93-
![Untitled](./images/cr_seat_manage_dark.png#gh-dark-mode-only)
94-
![Untitled](./images/cr_seat_manage_light.png#gh-light-mode-only)
85+
![Seat Management](./images/cr_seat_manage_dark.png#gh-dark-mode-only)
86+
![Seat Management](./images/cr_seat_manage_light.png#gh-light-mode-only)
9587

9688
###Free Plan
9789

9890
- Seats are assigned to new developers immediately
9991

100-
![Untitled](./images/cr_seat_free_dark.png#gh-dark-mode-only)
101-
![Untitled](./images/cr_seat_free_light.png#gh-light-mode-only)
92+
![Free Seat Assignment](./images/cr_seat_free_dark.png#gh-dark-mode-only)
93+
![Free Seat Assignment](./images/cr_seat_free_light.png#gh-light-mode-only)

‎docs/about/support.md‎

Lines changed: 35 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,73 @@
11
---
22
title:Support
33
sidebar_label:Support
4-
description:Accelerate Code Reviews with AI
5-
image:"/preview_meta.jpg"
4+
description:Get help with CodeRabbit and find answers to common questions.
65
---
76

8-
<head>
9-
<metacharSet="utf-8" />
10-
<metaname="title"content="CodeRabbit: AI-powered Code Reviews" />
11-
<metaname="description"content="Accelerate Code Reviews with AI" />
12-
13-
{" "}
14-
15-
<metaproperty="og:type"content="website" />
16-
<metaproperty="og:url"content="https://coderabbit.ai/" />
17-
<metaproperty="og:title"content="CodeRabbit: AI-powered Code Reviews" />
18-
<metaproperty="og:description"content="Accelerate Code Reviews with AI" />
19-
<metaproperty="og:image"content="/preview_meta.jpg" />
20-
21-
<metaname="twitter:image"content="https://coderabbit.ai/preview_meta.jpg" />
22-
<metaname="twitter:card"content="summary_large_image" />
23-
<metaname="twitter:title"content="CodeRabbit: AI-powered Code Reviews" />
24-
<metaname="twitter:description"content="Accelerate Code Reviews with AI" />
25-
</head>
26-
27-
Welcome to CodeRabbit's Support! Please refer this section if you encounter any issues or have questions. Our support team will respond back as soon as possible.
7+
Welcome to CodeRabbit's Support! Please refer to this section if you encounter
8+
any issues or have questions. Our support team will respond back as soon as
9+
possible.
2810

2911
###**Common Issues and Answers**
3012

31-
These are the most common questions our support team receives, and you might find an answer here
13+
These are the most common questions our support team receives, and you might
14+
find an answer here
3215

3316
###Can I switch between different organizations on CodeRabbit?
3417

35-
Yes, you can switch between different organizations on CodeRabbit. To do so, click on the organization name in the top right corner of the CodeRabbit UI.
18+
Yes, you can switch between different organizations on CodeRabbit. To do so,
19+
click on the organization name in the top-right corner of the CodeRabbit UI.
3620

37-
<divalign="center">![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)</div>
38-
<divalign="center">![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)</div>
21+
![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)</div>
22+
![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)</div>
3923

4024
###Can CodeRabbit subscription be used across multiple organizations?
4125

42-
Subscription seat are tied to the specific GitHub/GitLab organization under which they are purchased and cannot be used under another organization.
26+
Subscription seats are tied to the specific GitHub/GitLab organization under
27+
which they are purchased and cannot be used under another organization.
4328

4429
###Can CodeRabbit review my existing PRs after integrating it?
4530

46-
CodeRabbit would by default only review new PRs or existing PRs which have a new commits after the app is installed.
47-
You can however use@coderabbitai review command on the PR to trigger a review of existing PRs.
31+
CodeRabbit would by default only review new PRs or existing PRs which have a new
32+
commit after the app is installed. You can, however, use`@coderabbitai review`
33+
command on the PR to trigger a review of existing PRs.
4834

4935
###Who can add the repositories on CodeRabbit?
5036

51-
You need to be GitHub/GitLab admin to add the repositories.
37+
You need to beaGitHub/GitLab admin to add the repositories.
5238

53-
###Do I need own OpenAI key with CodeRabbit Pro?
39+
###Do I needmyown OpenAI key with CodeRabbit Pro?
5440

55-
OpenAI cost is part of the subscription.There is no additional cost for OpenAI.
41+
OpenAI cost is part of the subscription.There is no additional cost for OpenAI.
5642

57-
###What is the difference between CodeRabbit OSSai-pr-reviewerand CodeRabbit Pro?
43+
###What is the difference between CodeRabbit OSS and CodeRabbit Pro?
5844

59-
ai-pr-reviewer is our Open Source Software (OSS) for pull request reviews. With CodeRabbit OSS, you need your own OpenAI key, and you will incur OpenAI costs.
60-
On the other hand, with a CodeRabbit Pro subscription, the OpenAI cost is included. Additionally, CodeRabbit Pro offers advanced prompts and superior noise reduction features, which are not present in CodeRabbit OSS.
45+
[`ai-pr-reviewer`](https://github.com/coderabbitai/ai-pr-reviewer) project is
46+
our Open-Source Software (OSS) for pull request reviews. With CodeRabbit OSS,
47+
you need your own OpenAI key, and you will incur OpenAI costs. On the other
48+
hand, with a CodeRabbit Pro subscription, the OpenAI cost is included.
49+
Additionally, CodeRabbit Pro offers advanced prompts and superior noise
50+
reduction features, which are not present in CodeRabbit OSS.
6151

62-
###Can I use both CodeRabbit OSS and CodeRabbit Pro together?
52+
###Can I use both CodeRabbit OSS and CodeRabbit Pro together?
6353

64-
You can, but this will result in duplicate reviews. We suggest you use only one of the two.
54+
You can, but this will result in duplicate reviews. We suggest you use only one
55+
of the two.
6556

6657
###**Opening a Support Ticket**
6758

68-
To get assistance from our support team, open a ticket using the help icon on the CodeRabbit UI:
59+
To get assistance from our support team, open a ticket using the help icon on
60+
the CodeRabbit UI:
6961

70-
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.
62+
Complete the support ticket by providing your name, email, a description of your
63+
issue, and attaching any necessary files. If you are reporting a bug , please
64+
provide the GitHub or GitLab organization name.
7165

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

75-
:::tip
76-
To see more common issues faced by CodeRabbit users, visit our FAQsection for detailed answers and solutions to frequently encountered problems.
69+
:::tip To see more common issues faced by CodeRabbit users, visit our FAQ
70+
section for detailed answers and solutions to frequently encountered problems.
7771
:::
7872

7973
###**Community Collaboration**

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp