diff --git a/docs/about/features.md b/docs/about/features.md index 016fc5df..77589260 100644 --- a/docs/about/features.md +++ b/docs/about/features.md @@ -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. --- @@ -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. -![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) ### 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: @@ -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) -![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. -![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) diff --git a/docs/about/pricing.md b/docs/about/pricing.md index f3f69fa3..c788d59a 100644 --- a/docs/about/pricing.md +++ b/docs/about/pricing.md @@ -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 @@ -22,6 +21,18 @@ CodeRabbit. --- +## Open Source +:::note +CodeRabbit Pro is free for all Open Source projects. +::: + +- **Price**: $0/month +- Free forever +- No credit card required +- Unlimited public repositories + +--- + ## Pro Plan ### Features @@ -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** +- Number of reviews per hour (includes incremental reviews): **8** +- Number of conversations per hour: **50** --- @@ -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. +::: diff --git a/docs/about/support.md b/docs/about/support.md index 688d350d..e5e15b1c 100644 --- a/docs/about/support.md +++ b/docs/about/support.md @@ -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: support@coderabbit.ai. +::: + +## 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 -[support@coderabbit.ai](mailto:support@coderabbit.ai). +> CodeRabbit reserves the right to terminate Support Services in the event of any such objectionable communication. :::tip