Improve Documentation Structure and Accessibility in Markdown Files (#69)

* Major refactor

- Move configure and tools to top level
- Update category positions
- Move images to static dir
- Update links

* Update image file name in introduction.md

* Update sidebar positions for integrations documentation

* Update category positions for documentation

* Update knowledge base integration description

* Update FAQ with CodeRabbit comparison and CodeRabbit's uniqueness

* Update redirects in docusaurus.config.ts

* Update Jira and Linear integration configuration in knowledge base

* Update GitLab integration documentation

Author: hasit

docs/about/features.md

@@ -13,28 +13,28 @@ 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](./images/Summary-Overview.png)
+![Summary Overview](/img/about/Summary-Overview.png)
 
 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](./images/Summary-Walkthrough.png)
+![Summary Walkthrough](/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
 be copied or committed within the pull request with a single click.
 
-![Review Feedback](./images/ReviewFeedback.png)
+![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.
 
-![Review Status](./images/ReviewStatus.png)
+![Review Status](/img/about/ReviewStatus.png)
 
 ### 3. Chat with CodeRabbit {#chat-with-coderabbit}
 
@@ -44,11 +44,11 @@ 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.
 
-![Chat](./images/chat.png)
+![Chat](/img/about/chat.png)
 
 ### 4. Issue Validation {#issue-validation}
 
 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](./images/issue-validation.png)
+![Issue Validation](/img/about/issue-validation.png)

docs/about/images/CodeRabbitFlow.png

@@ -74,15 +74,15 @@ These are the hourly usage limits for each developer per repository:
 - During the trial period, seat assignment is automatic, but the number of seats
   can be adjusted when purchasing the subscription.
 
-![Seat Management](./images/cr_seat_manage_dark.png#gh-dark-mode-only)
-![Seat Management](./images/cr_seat_manage_light.png#gh-light-mode-only)
+![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)
 
 ### Free Plan
 
 - Seats are assigned to new developers immediately
 
-![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)
+![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)
 
 **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

docs/about/pricing.md

@@ -22,8 +22,8 @@ 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.
 
-![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)
+![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)
 
 ## Email Support
 
@@ -33,7 +33,7 @@ You can also reach out to us at
 :::tip
 
 To see more common issues faced by CodeRabbit users, visit our
-[FAQ section](../faq/faq.md) for detailed answers and solutions to frequently
+[FAQ section](../faq.md) for detailed answers and solutions to frequently
 encountered problems.
 
 :::

docs/about/support.md

@@ -5,7 +5,7 @@ description:
   CodeRabbit offers various configuration options to tailor the reviews to your
   specific requirements. Configuration can be made using one of the below
   options.
-sidebar_position: 1
+sidebar_position: 3
 ---
 
 ```mdx-code-block

docs/guides/configure-coderabbit.md renamed to docs/configure-coderabbit.md

@@ -2,6 +2,7 @@
 title: FAQs
 sidebar_label: FAQs
 description: Frequently asked questions about CodeRabbit.
+sidebar_position: 7
 ---
 
 ### General
@@ -37,15 +38,33 @@ uses proprietary code from private repositories for training purposes.
 Yes, you can switch between different organizations on CodeRabbit. To do so,
 click on the organization name in the top-left 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)
+![Switch Organizations](/img/faq/cr_support_orgs_light.png#gh-light-mode-only)
+![Switch Organizations](/img/faq/cr_support_orgs_dark.png#gh-dark-mode-only)
 
 #### 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.
 
+#### How does CodeRabbit compare to other AI code generators?
+
+Code reviews remain essential, whether the code is written by a human or a bot.
+This is mainly because the perspective of the reviewer differs from that of the
+code generator, whether human or machine. This distinction is precisely why
+human peer reviews have been effective for so long. While AI-powered
+code-generation tools like GitHub Copilot hold immense potential, it's important to recognize that
+these generators are still in their early stages and may not be equipped to
+auto-generate meaningful code for moderately complex applications.
+
+#### How is CodeRabbit different from other 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. 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.
+
 ### Subscription
 
 #### Can a CodeRabbit subscription be used across multiple organizations?
@@ -74,7 +93,7 @@ commit after the app is installed. You can, however, use the
 #### Can I customize CodeRabbit?
 
 Reviews are customizable. For information, check out our
-[Customization](../guides/review-instructions.md) guide.
+[Customization](./guides/review-instructions.md) guide.
 
 #### Can I choose a language other than English for the reviews?
 
@@ -123,7 +142,7 @@ cases, we re-allow further reviews/conversations after a brief timeout.
 
 #### Who can install CodeRabbit on the repositories?
 
-You need to be an admin of the orgnizaation to add the repositories.
+You need to be an admin of the organization to add the repositories.
 
 #### I can't add CodeRabbit to my GitLab Repositories. What should I do?
 
@@ -133,6 +152,6 @@ If there are any access restrictions by domain, then you will need to add
 :::tip
 
 If you have further questions or need additional information, please check out
-our [Support](../about/support.md) page for more details.
+our [Support](./about/support.md) page for more details.
 
 :::

docs/faq/faq.md renamed to docs/faq.md

@@ -1,4 +1,4 @@
 label: Guides
-position: 3
+position: 5
 collapsible: true
 collapsed: true

docs/guides/_category_.yml

@@ -43,8 +43,8 @@ upon selecting **Delete Account**. You can open the dropdowns for more
 information.
 
 <div align="center">
-![Delete Account](./images/delete_account_light.png#gh-light-mode-only)
-![Delete Account](./images/delete_account_dark.png#gh-dark-mode-only)
+![Delete Account](/img/guides/delete_account_light.png#gh-light-mode-only)
+![Delete Account](/img/guides/delete_account_dark.png#gh-dark-mode-only)
 </div>
 
 Deletion will only occur once the admin specifically types in "delete" in the

docs/guides/delete-account.md

@@ -25,7 +25,7 @@ Sign in to your CodeRabbit account and navigate to the [**API Keys**](https://ap
 Click on the **Create API Key** button and enter a name for the API Key.  
 Copy the API key, and keep it safe as it won't be visible again.
 
-![API Keys](./images/api_keys.png)
+![API Keys](/img/guides/api_keys.png)
 
 ## Generate an On-demand report
 

docs/guides/ondemand-reports.md

@@ -9,7 +9,7 @@ sidebar_position: 3
 ---
 
 The guide explains how to add custom review instructions for the entire project.
-Also, see the guide on how to [configure CodeRabbit](./configure-coderabbit.md).
+Also, see the guide on how to [configure CodeRabbit](../configure-coderabbit.md).
 
 ### Path-based instructions {#path-based}