Skip to content

Commit d1f8592

Browse files
docs: enhance Support, Features, and Intro pages; improve image SEO, internal linking, clarity, and layout. (#115)
* docs: enhance Support, Features, and Intro pages; improve image SEO, internal linking, clarity, and layout * docs: enhance Support, Features, and Intro pages; improve image SEO, internal linking, clarity, and layout * Update pricing.md --------- Co-authored-by: dikshant-infracloud <[email protected]>
1 parent 8cb7364 commit d1f8592

File tree

3 files changed

+100
-55
lines changed

3 files changed

+100
-55
lines changed

docs/about/features.md

+34-28
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: High-level Features
3-
sidebar_label: High-level Features
2+
title: CodeRabbit Features
3+
sidebar_label: Features
44
description: Learn how CodeRabbit works in a pull request review.
55
---
66

@@ -9,39 +9,44 @@ description: Learn how CodeRabbit works in a pull request review.
99
Generated upon the creation of a pull request and subsequently updated with each
1010
incremental request.
1111

12-
High-Level Summary: This offers a concise overview of the changes in the pull
12+
**High-Level Summary**: This offers a concise overview of the changes in the pull
1313
request. It helps the team, including those without technical expertise, to
1414
quickly understand the changes and the impact on the product.
1515

16-
![Summary Overview](/img/about/Summary-Overview.png)
16+
![CodeRabbit- Pull Request Summary](/img/about/Summary-Overview.png)
1717

18-
Walkthrough: A detailed code walkthrough to understand the changes in each file
18+
**Walkthrough**: A detailed code walkthrough to understand the changes in each file
1919
that is part of the pull request, followed by a celebratory poem about the
2020
changes.
2121

22-
![Summary Walkthrough](/img/about/Summary-Walkthrough.png)
22+
![CodeRabbit- Pull Request Walkthrough Example](/img/about/Summary-Walkthrough.png)
2323

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

26-
Review feedback is posted as review comments on the lines of the code that
27-
changed for each file. Code suggestions are given in a Diff format, which either
26+
**Code review** feedback is posted as review comments on the lines of the code that
27+
changed for each file.
28+
29+
> Code suggestions are given in a Diff format, which either
2830
be copied or committed within the pull request with a single click.
2931

30-
![Review Feedback](/img/about/ReviewFeedback.png)
32+
![CodeRabbit- Code Review Feedback](/img/about/ReviewFeedback.png)
3133

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

37-
![Review Status](/img/about/ReviewStatus.png)
38+
:::info
39+
Review status is useful for understanding the auxiliary context of the review.
40+
:::
41+
![CodeRabbit- Review Status](/img/about/ReviewStatus.png)
3842

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

41-
CodeRabbit provides conversational capability that allows developers and the
45+
- **CodeRabbit** provides conversational capability that allows developers and the
4246
reviewers to ask questions, generate code, and get feedback in the context of
4347
changes. Just comment on the CodeRabbit review to start the conversation.
44-
CodeRabbit learns from your interactions and gets smarter over time. The more
48+
49+
- **CodeRabbit** learns from your interactions and gets smarter over time. The more
4550
you chat, the better it gets.
4651

4752
We support:
@@ -50,37 +55,38 @@ We support:
5055
- Comments in Pull Requests
5156
- Comments in Git Issues
5257

53-
![Chat](/img/about/chat.png)
58+
![Chat with CodeRabbit - Conversation in Pull Requests](/img/about/chat.png)
5459

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

57-
Pull request changes are validated against the linked GitHub or GitLab issue and
62+
**Pull request** changes are validated against the linked GitHub or GitLab issue and
5863
identifies all other issues which might be affected by this change.
5964

60-
![Issue Validation](/img/about/issue-validation.png)
65+
![Issue Validation for GitHub/GitLab Issues - CodeRabbit](/img/about/issue-validation.png)
6166

6267
### 5. Sequence Diagrams {#sequence-diagrams}
6368

64-
CodeRabbit visualizes the changes occuring in any pull request using
65-
[Mermaid Diagrams](https://mermaid.live/).
69+
**CodeRabbit** visualizes the changes occuring in any pull request using
70+
[Mermaid Sequence Diagram Example](https://mermaid.live/).
6671

6772
![Diagram](/img/about/diagram.png)
6873

69-
![Advanced Diagram](/img/about/advanced-diagram.png)
74+
![Advanced Sequence Diagram Example - CodeRabbit](/img/about/advanced-diagram.png)
7075

7176
### 6. Commitable Suggestions {#commitable-suggestions}
7277

73-
For quick fixes, CodeRabbit offers one button solution to commit AI recommended
74-
changes!
78+
For quick fixes, **CodeRabbit** offers one button solution to commit AI recommended
79+
changes.
7580

76-
![Commitable Suguestion](/img/about/committable-suggestion.png)
81+
![AI Recommended Suggestions - CodeRabbit](/img/about/committable-suggestion.png)
7782

78-
![Irony](/img/about/ironic-committable.png)
83+
![Irony in Committable Suggestions - CodeRabbit](/img/about/ironic-committable.png)
7984

8085
### 7. Learnings {#learnings}
8186

82-
CodeRabbit learns from user chat interactions to gain tribal knowledge on your
83-
repositories and organization. CodeRabbit will apply and update these learnings
84-
in future reviews
87+
- **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your
88+
repositories and organization.
89+
- **CodeRabbit** will apply and update these learnings
90+
in future reviews.
8591

86-
![Learnings](/img/about/learnings.png)
92+
![Learnings from Interactions - CodeRabbit AI](/img/about/learnings.png)

docs/about/pricing.md

+41-13
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ sidebar_label: Pricing
44
description: Learn about the plans, pricing, and subscription management of CodeRabbit.
55
---
66

7-
This section covers the plans, pricing, and subscription management of
8-
CodeRabbit.
7+
Find all the information you need about CodeRabbit's plans and how to manage your monthly bill.
98

109
## Overview
1110

@@ -22,6 +21,18 @@ CodeRabbit.
2221

2322
---
2423

24+
## Open Source
25+
:::note
26+
CodeRabbit Pro is free for all Open Source projects.
27+
:::
28+
29+
- **Price**: $0/month
30+
- Free forever
31+
- No credit card required
32+
- Unlimited public repositories
33+
34+
---
35+
2536
## Pro Plan
2637

2738
### Features
@@ -34,16 +45,16 @@ CodeRabbit.
3445

3546
### Pricing
3647

37-
- Monthly: $15 per month per contributing developer.
38-
- Annual: $12 per month, billed annually per contributing developer.
48+
- **Monthly**: $15 per month per contributing developer.
49+
- **Annual**: $12 per month, billed annually per contributing developer.
3950

4051
### Usage Limits
4152

4253
These are the hourly usage limits for each developer per repository:
4354

44-
- Number of files reviewed per hour: 150 Files
45-
- Number of reviews per hour (includes incremental reviews): 9
46-
- Number of conversations per hour: 50
55+
- Number of files reviewed per hour: **150 Files**
56+
- Number of reviews per hour (includes incremental reviews): **8**
57+
- Number of conversations per hour: **50**
4758

4859
---
4960

@@ -62,27 +73,44 @@ These are the hourly usage limits for each developer per repository:
6273

6374
---
6475

76+
## Plan Comparison
77+
78+
| Feature | Free Plan | Pro Plan |
79+
| ----------------------------- | ---------------- | --------------- |
80+
| **Free Trial** | 14-day free trial| 14-day free trial|
81+
| **Private Repos** | Limited access | Unlimited access|
82+
| **Public Repos** | Unlimited access | Unlimited access|
83+
| **Pull Request Summarization** | Included | Included |
84+
| **Line-by-Line Reviews** | Public repos only | All repos |
85+
| **Conversational Bot** | No | Yes |
86+
| **Hourly Usage Limits** | Limited | 150 files/hour, 9 reviews/hour, 50 conversations/hour |
87+
| **Price** | Free forever | $15 per seat/mo |
88+
89+
---
90+
6591
## Subscription Management
6692

6793
### Pro Plan
6894

69-
- GitHub/GitLab organization owners can purchase or introduce changes to the
95+
- [GitHub/GitLab](docs/tools/tools.md) organization owners can purchase or introduce changes to the
7096
subscription.
7197
- You can choose to manually purchase seats and assign them to developers, or
7298
have them assigned automatically as developers create pull requests.
7399
- During the trial period, seat assignment is automatic, but the number of seats
74100
can be adjusted when purchasing the subscription.
75101

76-
![Seat Management](/img/about/cr_seat_manage_dark.png#gh-dark-mode-only)
77-
![Seat Management](/img/about/cr_seat_manage_light.png#gh-light-mode-only)
102+
![Seat Management for CodeRabbit Subscription](/img/about/cr_seat_manage_dark.png#gh-dark-mode-only)
103+
![Seat Management for CodeRabbit Subscription](/img/about/cr_seat_manage_light.png#gh-light-mode-only)
78104

79105
### Free Plan
80106

81107
- Seats are assigned to new developers immediately
82108

83-
![Free Seat Assignment](/img/about/cr_seat_free_dark.png#gh-dark-mode-only)
84-
![Free Seat Assignment](/img/about/cr_seat_free_light.png#gh-light-mode-only)
109+
![Free Plan Seat Assignment - CodeRabbit](/img/about/cr_seat_free_dark.png#gh-dark-mode-only)
110+
![Free Plan Seat Assignment - CodeRabbit](/img/about/cr_seat_free_light.png#gh-light-mode-only)
85111

86-
**Note:** The subscription is limited to human users; bot users are not
112+
:::note
113+
The subscription is limited to human users; bot users are not
87114
supported. Thus, pull requests or merge requests created by bots will not be
88115
reviewed.
116+
:::

docs/about/support.md

+25-14
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,42 @@ sidebar_label: Support
44
description: Get help with CodeRabbit and find answers to common questions.
55
---
66

7-
Welcome to CodeRabbit Support! Please refer to the following sections for
7+
Welcome to CodeRabbit Support. Please refer to the following sections for
88
contacting our support team. Our support team will respond back as soon as
99
possible.
1010

11-
## Community Discord
11+
## Discord Server
1212

13-
For real-time support and to connect with other CodeRabbit users, join our
14-
[Discord](http://discord.gg/GsXnASn26c).
13+
All CodeRabbit users have access to the [CodeRabbit Discord Server](http://discord.gg/coderabbit), where you can ask questions or see what others are doing with CodeRabbit. You will find CodeRabbit users and members of the CodeRabbit team actively engaged.
1514

1615
## Support Tickets
1716

18-
To get assistance from our support team, open a ticket using the help icon on
19-
the CodeRabbit UI:
17+
:::tip
18+
For assistance from our support team, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://app.coderabbit.ai/login). This will open a chat window where you can submit your support ticket.
19+
:::
20+
21+
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.
22+
23+
24+
![How to Open a Support Ticket-CodeRabbit ](/img/about/cr_support_help_light.png#gh-light-mode-only)
25+
![How to Open a Support Ticket-CodeRabbit ](/img/about/cr_support_help_dark.png#gh-dark-mode-only)
26+
27+
:::note
28+
If you are a paying user and cannot access the support ticket form in the CodeRabbit UI for some reason, you can contact CodeRabbit support at the following email address: [email protected].
29+
:::
30+
31+
## Customer Responsibilities
2032

21-
Complete the support ticket by providing your name, email, a description of your
22-
issue, and attaching any necessary files. If you are reporting a bug, please
23-
provide the GitHub or GitLab organization name.
33+
> To ensure efficient resolution of issues, customers are expected to
2434
25-
![Open a Ticket](/img/about/cr_support_help_light.png#gh-light-mode-only)
26-
![Open a Ticket](/img/about/cr_support_help_dark.png#gh-dark-mode-only)
35+
1. Provide detailed information about the issue.
36+
2. Cooperate with the Support team during troubleshooting.
37+
3. Utilize available self-service resources/docs for basic inquiries.
2738

28-
## Email Support
39+
## Etiquette
40+
Regardless of the method or location through which CodeRabbit provides Support, communication should be professional and respectful. Any communication that is deemed objectionable by CodeRabbit staff is not tolerated. This includes but is not limited to any communication that is abusive or contains profane language.
2941

30-
You can also reach out to us at
31-
42+
> CodeRabbit reserves the right to terminate Support Services in the event of any such objectionable communication.
3243
3344
:::tip
3445

0 commit comments

Comments
 (0)