doc fixes

docs/about/features.md

@@ -1,6 +1,6 @@
 ---
-title: CodeRabbit in Action
-sidebar_label: CodeRabbit in Action
+title: High-level Features
+sidebar_label: High-level Features
 description: Learn how CodeRabbit works in a pull request review.
 ---
 
@@ -23,13 +23,19 @@ changes.
 
 ### 2. Code Review feedback {#code-review-feedback}
 
-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.
+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)
 
+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)
+
 ### 3. Chat with CodeRabbit {#chat-with-coderabbit}
 
 CodeRabbit provides conversational capability that allows developers and the
@@ -47,14 +53,5 @@ identifies all other issues which might be affected by this change.
 
 ![Issue Validation](./images/issue-validation.png)
 
-### 5. Pull Request review status {#pull-request-review-status}
-
-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.
-
-![Review Status](./images/ReviewStatus.png)
-
 For information on how to get started with CodeRabbit, visit
 the [Get Started page](/get-started/signup)

docs/about/pricing.md

@@ -1,6 +1,6 @@
 ---
-title: Plans
-sidebar_label: Plans
+title: Pricing Plans
+sidebar_label: Pricing Plans
 description:
   Learn about the plans, pricing, and subscription management of CodeRabbit.
 ---
@@ -92,5 +92,6 @@ These are the hourly usage limits for each developer per repository:
 ![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)
 
-
-**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.
+**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.

docs/about/support.md

@@ -4,57 +4,16 @@ sidebar_label: Support
 description: Get help with CodeRabbit and find answers to common questions.
 ---
 
-Welcome to CodeRabbit's Support! Please refer to this section if you encounter
-any issues or have questions. Our support team will respond back as soon as
+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.
 
-### **Common Issues and Answers**
+## Community Discord
 
-These are the most common questions our support team receives, and you might
-find an answer here
+For real-time support and to connect with other CodeRabbit users, join our
+[Discord](http://discord.gg/GsXnASn26c).
 
-### Can I switch between different organizations on CodeRabbit?
-
-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.
-
-![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)
-![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)
-
-### Can CodeRabbit subscription be used across multiple organizations?
-
-Subscription seats are tied to the specific GitHub/GitLab organization under
-which they are purchased and cannot be used under another organization.
-
-### Can CodeRabbit review my existing PRs after integrating it?
-
-CodeRabbit would by default only review new PRs or existing PRs which have a new
-commit after the app is installed. You can, however, use the
-`@coderabbitai review` command on the PR to trigger a review of existing PRs.
-
-### Who can add the repositories on CodeRabbit?
-
-You need to be a GitHub/GitLab admin to add the repositories.
-
-### Do I need my own OpenAI key with CodeRabbit Pro?
-
-OpenAI cost is part of the subscription. There is no additional cost for OpenAI.
-
-### What is the difference between CodeRabbit OSS and CodeRabbit Pro?
-
-[`ai-pr-reviewer`](https://github.com/coderabbitai/ai-pr-reviewer) project 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. 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.
-
-### Can I use both CodeRabbit OSS and CodeRabbit Pro together?
-
-You can, but this will result in duplicate reviews. We suggest you use only one
-of the two.
-
-### **Opening a Support Ticket**
+## Support Tickets
 
 To get assistance from our support team, open a ticket using the help icon on
 the CodeRabbit UI:
@@ -66,13 +25,15 @@ 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)
 
-:::tip
+## Email Support
 
-To see more common issues faced by CodeRabbit users, visit our FAQ section for
-detailed answers and solutions to frequently encountered problems.
+You can also reach out to us at
+[[email protected]](mailto:[email protected]).
 
-:::
+:::tip
 
-### **Community Collaboration**
+To see more common issues faced by CodeRabbit users, visit our
+[FAQ section](../faq/faq.md) for detailed answers and solutions to frequently
+encountered problems.
 
-Consider joining the CodeRabbit community on Discord.
+:::

docs/faq/faq.md

@@ -4,81 +4,109 @@ sidebar_label: FAQs
 description: Frequently asked questions about CodeRabbit.
 ---
 
-#### **1. How accurate is CodeRabbit's review?**
+#### How accurate is CodeRabbit's review?
 
 Early adoption results for CodeRabbit have been highly promising, demonstrating
 significant accuracy in code reviews. However, it's crucial to understand that
 AI is an evolving field, and absolute 100% accuracy can't be guaranteed. Our
-technology is continuously learning and improving, aiming for the highest
-possible accuracy in reviews.
+technology is continuously improving, aiming for the highest possible accuracy
+in reviews.
 
-#### **2. Which programming languages does CodeRabbit support?**
+#### Which programming languages does CodeRabbit support?
 
 CodeRabbit is designed to work with all programming languages. However, the
-proficiency of our AI models might vary between languages, which could slightly
-affect the accuracy of the review.
+proficiency of our AI models might vary between languages based on their
+popularity and the public availability of training data.
 
-#### **3. Does CodeRabbit store my code ?**
+#### Does CodeRabbit store my code?
 
-We do not store any source code. The code collected at the time of the review is disposed of as soon as the review is complete. During the review, there is complete data isolation for the code being reviewed, and no one from CodeRabbit or outside has access to the code.
+We do not store your code. The code collected at the time of the review is
+disposed off as soon as the review is complete. During the review, there is
+complete data isolation of the code being reviewed, and no one from CodeRabbit
+or outside has access to the code.
 
-#### **4. Does CodeRabbit use my proprietary code for training language models?**
+#### Does CodeRabbit use my proprietary code for training language models?
 
-We train our system only using open source projects. CodeRabbit never uses the proprietary 
-code on private repositories for training purposes.
+We train our system only using publicly available datasets. CodeRabbit never
+uses the proprietary code from private repositories for training purposes.
 
-#### **5. What Large Language Models does CodeRabbit use?**
+#### Can I switch between different organizations on CodeRabbit?
+
+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.
+
+![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)
+![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)
+
+#### Can CodeRabbit subscription be used across multiple organizations?
+
+Subscription seats are tied to the specific GitHub/GitLab organization under
+which they are purchased and cannot be used under another organization.
+
+#### Can CodeRabbit review my existing PRs after integrating it?
+
+CodeRabbit would by default only review new PRs or existing PRs which have a new
+commit after the app is installed. You can, however, use the
+`@coderabbitai review` command on the PR to trigger a review of existing PRs.
+
+#### Who can add the repositories on CodeRabbit?
+
+You need to be a GitHub/GitLab admin to add the repositories.
+
+#### Do I need my own OpenAI key with CodeRabbit Pro?
+
+OpenAI cost is included as part of the subscription. You don't need to have your
+own OpenAI key.
+
+#### 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.
 
-#### **6. Can I customize CodeRabbit?**
+#### Can I customize CodeRabbit?
 
 Reviews are customizable. For information, check out our
 [Get Started page](../get-started/signup.md).
 
-#### **7. Can I choose a language other than English for the reviews?**
+#### Can I choose a language other than English for the reviews?
 
 CodeRabbit supports most widely used languages. You can configure this in the
 repository settings.
 
-#### **8. What access does CodeRabbit need to my repositories?**
+#### What access does CodeRabbit need to my repositories?
 
 CodeRabbit requests minimal access to perform code reviews and post comments on
 Pull Requests. On GitHub, it requires read access to metadata, code,
 discussions, issues, and read/write access to the pull requests. On GitLab, it
 requires read access to the repository, and the CodeRabbit Bot user requires a
 developer role.
 
-#### **9. How can I add or remove users for my subscription?**
+#### How can I add or remove users for my subscription?
 
 To manage users, log in to CodeRabbit and navigate to subscriptions. You can add
 or remove users as needed.
 
-#### **10. How can I interact with the CodeRabbit bot?**
+#### How can I interact with the CodeRabbit bot?
 
 To interact with CodeRabbit's bot, reply to the CodeRabbit Comment. If there are
 team members collaborating on pull requests, the bot stays silent by default but
-can be engaged by tagging **@Coderabbitai**. This feature allows you to provide
+can be engaged by tagging **@coderabbitai**. This feature allows you to provide
 context, generate test cases, or ask for specific code suggestions, all within
 the context of your code lines or entire files.
 
-#### **11. Can individual developers use CodeRabbit?**
+#### Can individual developers use CodeRabbit?
 
 Absolutely! Whether you're an individual developer or part of an organization,
 CodeRabbit can be your coding assistant, providing you with invaluable
 suggestions.
 
-#### **12. Which branches are the pull requests reviewed on?**
+#### Which branches are the pull requests reviewed on?
 
-CodeRabbit reviews pull requests on the default branch.
+CodeRabbit reviews pull requests on the default branch by default. You can
+change this in the repository settings.
 
-#### **13. Is it possible for CodeRabbit to include additional branches for review?**
-
-Yes, you can change it under the repository settings.
-
-#### **14. CodeRabbit Usage Limits**
+#### CodeRabbit Usage Limits
 
 There are hourly rate limits for each developer per repository:
 
@@ -89,18 +117,14 @@ There are hourly rate limits for each developer per repository:
 In-trial and open-source plans have lower rate limits than the paid plan. In all
 cases, we re-allow further reviews/conversations after a brief timeout.
 
-#### **15. I can't add CodeRabbit to my GitLab Repositories?**
+#### I can't add CodeRabbit to my GitLab Repositories. What should I do?
 
 If there are any access restrictions by domain, then you will need to add
 `coderabbit.ai` as an allowed domain.
 
-:::note
+:::tip
 
-We are continually innovating and enhancing our application with new
-capabilities. Stay tuned and follow us for updates as new exciting features are
-built. We're committed to making your experience with CodeRabbit even better.
+If you have further questions or need additional information, please check out
+our [Support](../about/support.md) page for more details.
 
 :::
-
-If you have further questions or need additional information, don't hesitate to
-reach out to us at [[email protected]](mailto:[email protected]).

docs/introduction/introduction.md

@@ -12,10 +12,10 @@ slug: "/"
 **CodeRabbit** is an innovative, AI-first code reviewer. It provides
 context-aware review feedback on a pull request within minutes, thereby
 significantly reducing the time and effort associated with manual code reviews.
-Secondly, it brings a different perspective to the reviews and finds issues
+Additionally, it brings a different perspective to the reviews and finds issues
 often missed by the human eye. Developers can chat with the bot within the code,
 which allows them to provide additional context, ask questions, or have the bot
-generate code. It learns from your suggestions and gets better overtime.
+generate code. It learns from your suggestions and gets better over time.
 
 **CodeRabbit** seamlessly integrates with GitHub and GitLab repositories,
 performing continuous, incremental reviews for each commit within a pull
@@ -30,17 +30,22 @@ A comprehensive review is performed when a PR or MR is created, and for
 incremental commits and comments addressed to the bot. The feedback is then sent
 directly back to the PR or MR.
 
-![](../about/images/CodeRabbitFlow.png)
+![CodeRabbit Flow](../about/images/CodeRabbitFlow.png)
 
 ### Data, Privacy, and Security
 
 **CodeRabbit** does not use data collected during code reviews to train or
-influence the models. Queries to the Large Language Model (LLM) are ephemeral and there is zero data retention on LLMs.
-Neither we nor the LLM we use share any data collected during the code review
-process with other third parties.
+influence the models. Queries to the Large Language Models (LLMs) are ephemeral
+and there is zero retention on LLMs. Neither we nor the LLMs provider(s) share
+any data collected during the code review process with third parties.
 
-Does CodeRabbit store my Data? 
-CodeRabbit enhances future reviews for your organization by storing the embeddings of the learnings generated from chat conversations. Additionally, it integrates embeddings from issues in workflow systems (Liner, Jira, GitHub/GitLab issues) to assess the impact of code changes on existing issues
+Data storage: Code downloaded during the review process is stored temporarily
+and is deleted after the review processing is complete. The code is not stored
+or used for any other purpose. However, CodeRabbit enhances future reviews for
+your organization by storing the embeddings of the learnings generated from chat
+conversations. Additionally, it integrates embeddings from issues in workflow
+systems (Liner, Jira, GitHub/GitLab issues) to assess the impact of code changes
+on existing issues
 
 Compliance and Data Privacy: Your data is kept confidential, isolated by the
 organization, and used only to improve your organization reviews. Data storage
@@ -61,7 +66,11 @@ auto-generate meaningful code for moderately complex applications.
 
 ### How is CodeRabbit different from existing 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.
+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.
 
 For information on how to get started with **CodeRabbit**, please visit the
 [Get Started page](./get-started/signup).