Skip to content

docs: enhance Support, Features, and Intro pages; improve image SEO, internal linking, clarity, and layout. #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 24, 2024
Merged

docs: enhance Support, Features, and Intro pages; improve image SEO, internal linking, clarity, and layout. #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a52e36
docs: enhance Support, Features, and Intro pages; improve image SEO, …
tyaga001 Oct 23, 2024
1dd5ff7
docs: enhance Support, Features, and Intro pages; improve image SEO, …
tyaga001 Oct 24, 2024
e847df7
Update pricing.md
dikshant-infracloud Oct 24, 2024
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
62 changes: 34 additions & 28 deletions docs/about/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: High-level Features
sidebar_label: High-level Features
title: CodeRabbit Features
sidebar_label: Features
description: Learn how CodeRabbit works in a pull request review.
---

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

High-Level Summary: This offers a concise overview of the changes in the pull
**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](/img/about/Summary-Overview.png)
![CodeRabbit- Pull Request Summary](/img/about/Summary-Overview.png)

Walkthrough: A detailed code walkthrough to understand the changes in each file
**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](/img/about/Summary-Walkthrough.png)
![CodeRabbit- Pull Request Walkthrough Example](/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
**Code 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.
Comment on lines +29 to 30
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Improve blockquote clarity and grammar.

The current blockquote about code suggestions could be clearer.

Apply this diff:

-> Code suggestions are given in a Diff format, which either
-be copied or committed within the pull request with a single click.
+> Code suggestions are provided in a Diff format, which can be either
+> copied or committed within the pull request with a single click.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> Code suggestions are given in a Diff format, which either
be copied or committed within the pull request with a single click.
> Code suggestions are provided in a Diff format, which can be either
> copied or committed within the pull request with a single click.


![Review Feedback](/img/about/ReviewFeedback.png)
![CodeRabbit- Code 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.
additional comments generated for each review, and so on.

![Review Status](/img/about/ReviewStatus.png)
:::info
Review status is useful for understanding the auxiliary context of the review.
:::
![CodeRabbit- Review Status](/img/about/ReviewStatus.png)
Comment on lines +26 to +41
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix trailing whitespace.

There's a trailing whitespace on line 27 that should be removed.

Apply this diff:

-changed for each file. 
+changed for each file.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Code 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](/img/about/ReviewFeedback.png)
![CodeRabbit- Code 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.
additional comments generated for each review, and so on.
![Review Status](/img/about/ReviewStatus.png)
:::info
Review status is useful for understanding the auxiliary context of the review.
:::
![CodeRabbit- Review Status](/img/about/ReviewStatus.png)
**Code 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.
![CodeRabbit- Code 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.
:::info
Review status is useful for understanding the auxiliary context of the review.
:::
![CodeRabbit- Review Status](/img/about/ReviewStatus.png)
🧰 Tools
🪛 Markdownlint

27-27: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


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

CodeRabbit provides conversational capability that allows developers and the
- **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

- **CodeRabbit** learns from your interactions and gets smarter over time. The more
you chat, the better it gets.

We support:
Expand All @@ -50,37 +55,38 @@ We support:
- Comments in Pull Requests
- Comments in Git Issues

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

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

Pull request changes are validated against the linked GitHub or GitLab issue and
**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](/img/about/issue-validation.png)
![Issue Validation for GitHub/GitLab Issues - CodeRabbit](/img/about/issue-validation.png)

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

CodeRabbit visualizes the changes occuring in any pull request using
[Mermaid Diagrams](https://mermaid.live/).
**CodeRabbit** visualizes the changes occuring in any pull request using
[Mermaid Sequence Diagram Example](https://mermaid.live/).

![Diagram](/img/about/diagram.png)
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Update image caption to match branding pattern.

For consistency with other image captions, this should follow the CodeRabbit branding pattern.

Apply this diff:

-![Diagram](/img/about/diagram.png)
+![CodeRabbit- Basic Sequence Diagram](/img/about/diagram.png)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
![Diagram](/img/about/diagram.png)
![CodeRabbit- Basic Sequence Diagram](/img/about/diagram.png)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coderabbitai remember to make all markdown image tags to follow SEO guidelines. Like the one listed here. Make this consistent across Docs Pull Requests.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aravindputrevu, understood. I'll ensure all markdown image tags in the documentation follow SEO guidelines and maintain consistency across Docs Pull Requests.

(_/)
(•_•)
/>🌱

✏️ Learnings added 
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#115
File: docs/about/features.md:72-72
Timestamp: 2024-10-24T10:08:27.685Z
Learning: In documentation files, ensure all markdown image tags follow SEO guidelines and maintain consistency across Docs Pull Requests.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.


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

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

For quick fixes, CodeRabbit offers one button solution to commit AI recommended
changes!
For quick fixes, **CodeRabbit** offers one button solution to commit AI recommended
changes.
Comment on lines +78 to +79
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix grammar in description.

Add the article "a" before "one button solution" for better grammar.

Apply this diff:

-For quick fixes, **CodeRabbit** offers one button solution to commit AI recommended
+For quick fixes, **CodeRabbit** offers a one-button solution to commit AI recommended
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
For quick fixes, **CodeRabbit** offers one button solution to commit AI recommended
changes.
For quick fixes, **CodeRabbit** offers a one-button solution to commit AI recommended
changes.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~78-~78: You might be missing the article “a” here.
Context: ... For quick fixes, CodeRabbit offers one button solution to commit AI recommende...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


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

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

### 7. Learnings {#learnings}

CodeRabbit learns from user chat interactions to gain tribal knowledge on your
repositories and organization. CodeRabbit will apply and update these learnings
in future reviews
- **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your
repositories and organization.
- **CodeRabbit** will apply and update these learnings
in future reviews.

![Learnings](/img/about/learnings.png)
![Learnings from Interactions - CodeRabbit AI](/img/about/learnings.png)
Comment on lines +87 to +92
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix trailing whitespace.

There's a trailing whitespace on line 88 that should be removed.

Apply this diff:

-repositories and organization. 
+repositories and organization.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your
repositories and organization.
- **CodeRabbit** will apply and update these learnings
in future reviews.
![Learnings](/img/about/learnings.png)
![Learnings from Interactions - CodeRabbit AI](/img/about/learnings.png)
- **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your
repositories and organization.
- **CodeRabbit** will apply and update these learnings
in future reviews.
![Learnings from Interactions - CodeRabbit AI](/img/about/learnings.png)
🧰 Tools
🪛 Markdownlint

88-88: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

54 changes: 41 additions & 13 deletions docs/about/pricing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ sidebar_label: Pricing
description: Learn about the plans, pricing, and subscription management of CodeRabbit.
---

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

## Overview

Expand All @@ -22,6 +21,18 @@ CodeRabbit.

---

## Open Source
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add blank line before heading.

Add a blank line before the "Open Source" heading to improve readability and comply with markdown best practices.

+
## Open Source
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Open Source
## Open Source
🧰 Tools
🪛 Markdownlint

24-24: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

:::note
CodeRabbit Pro is free for all Open Source projects.
:::
Comment on lines +24 to +27
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix markdown formatting and hyphenation.

Two minor improvements needed:

  1. Add a blank line before the "Open Source" heading
  2. Hyphenate "Open-Source" when used as a compound adjective

Apply this diff:

+
## Open Source
:::note
-CodeRabbit Pro is free for all Open Source projects.
+CodeRabbit Pro is free for all Open-Source projects.
:::
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Open Source
:::note
CodeRabbit Pro is free for all Open Source projects.
:::
## Open Source
:::note
CodeRabbit Pro is free for all Open-Source projects.
:::
🧰 Tools
🪛 LanguageTool

[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... :::note CodeRabbit Pro is free for all Open Source projects. ::: - Price: $0/month - ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🪛 Markdownlint

24-24: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


- **Price**: $0/month
- Free forever
- No credit card required
- Unlimited public repositories

---

## Pro Plan

### Features
Expand All @@ -34,16 +45,16 @@ CodeRabbit.

### Pricing

- Monthly: $15 per month per contributing developer.
- Annual: $12 per month, billed annually per contributing developer.
- **Monthly**: $15 per month per contributing developer.
- **Annual**: $12 per month, billed annually per contributing developer.

### Usage Limits

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

- Number of files reviewed per hour: 150 Files
- Number of reviews per hour (includes incremental reviews): 9
- Number of conversations per hour: 50
- Number of files reviewed per hour: **150 Files**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dikshant-infracloud can you take a look at this, considering the recent discussion

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi @aravindputrevu , changes looks good. I have also updated the values to 150.
We should change the Number of reviews per hour (includes incremental reviews) to 8 to avoid any confusion.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dikshant-infracloud

- Number of reviews per hour (includes incremental reviews): **8**
- Number of conversations per hour: **50**
Comment on lines +55 to +57
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix inconsistent review limit values.

There's a discrepancy in the stated number of reviews per hour:

  • Usage Limits section states "8" reviews per hour
  • Plan Comparison table states "9" reviews per hour

Please update one of these values to ensure consistency.

Also applies to: 86-86


---

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

---

## Plan Comparison

| Feature | Free Plan | Pro Plan |
| ----------------------------- | ---------------- | --------------- |
| **Free Trial** | 14-day free trial| 14-day free trial|
| **Private Repos** | Limited access | Unlimited access|
| **Public Repos** | Unlimited access | Unlimited access|
| **Pull Request Summarization** | Included | Included |
| **Line-by-Line Reviews** | Public repos only | All repos |
| **Conversational Bot** | No | Yes |
| **Hourly Usage Limits** | Limited | 150 files/hour, 9 reviews/hour, 50 conversations/hour |
| **Price** | Free forever | $15 per seat/mo |

---

## Subscription Management

### Pro Plan

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

![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)
![Seat Management for CodeRabbit Subscription](/img/about/cr_seat_manage_dark.png#gh-dark-mode-only)
![Seat Management for CodeRabbit Subscription](/img/about/cr_seat_manage_light.png#gh-light-mode-only)

### Free Plan

- Seats are assigned to new developers immediately

![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)
![Free Plan Seat Assignment - CodeRabbit](/img/about/cr_seat_free_dark.png#gh-dark-mode-only)
![Free Plan Seat Assignment - CodeRabbit](/img/about/cr_seat_free_light.png#gh-light-mode-only)

**Note:** The subscription is limited to human users; bot users are not
:::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
reviewed.
:::
39 changes: 25 additions & 14 deletions docs/about/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,42 @@ sidebar_label: Support
description: Get help with CodeRabbit and find answers to common questions.
---

Welcome to CodeRabbit Support! Please refer to the following sections for
Welcome to CodeRabbit Support. Please refer to the following sections for
contacting our support team. Our support team will respond back as soon as
possible.

## Community Discord
## Discord Server

For real-time support and to connect with other CodeRabbit users, join our
[Discord](http://discord.gg/GsXnASn26c).
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.

## Support Tickets

To get assistance from our support team, open a ticket using the help icon on
the CodeRabbit UI:
:::tip
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.
:::

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.


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

:::note
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].
:::

## Customer Responsibilities

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.
> To ensure efficient resolution of issues, customers are expected to

![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)
1. Provide detailed information about the issue.
2. Cooperate with the Support team during troubleshooting.
3. Utilize available self-service resources/docs for basic inquiries.

## Email Support
## Etiquette
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.

You can also reach out to us at
[[email protected]](mailto:[email protected]).
> CodeRabbit reserves the right to terminate Support Services in the event of any such objectionable communication.

:::tip

Expand Down