Skip to content

Commit 822941d

Browse files
hasithasit
authored
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
1 parent 4b20874 commit 822941d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+105
-66
lines changed

‎docs/about/features.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,28 @@ 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](./images/Summary-Overview.png)
16+
![Summary Overview](/img/about/Summary-Overview.png)
1717

1818
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](./images/Summary-Walkthrough.png)
22+
![Summary Walkthrough](/img/about/Summary-Walkthrough.png)
2323

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

2626
Review feedback is posted as review comments on the lines of the code that
2727
changed for each file. Code suggestions are given in a Diff format, which either
2828
be copied or committed within the pull request with a single click.
2929

30-
![Review Feedback](./images/ReviewFeedback.png)
30+
![Review Feedback](/img/about/ReviewFeedback.png)
3131

3232
A review status is generated for each commit that is reviewed. It displays the
3333
commit IDs that were reviewed, the files examined and ignored, as well as the
3434
additional comments generated for each review, and so on. Review status is
3535
useful for understanding the auxiliary context of the review.
3636

37-
![Review Status](./images/ReviewStatus.png)
37+
![Review Status](/img/about/ReviewStatus.png)
3838

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

@@ -44,11 +44,11 @@ changes. Just comment on the CodeRabbit review to start the conversation.
4444
CodeRabbit learns from your interactions and gets smarter over time. The more
4545
you chat, the better it gets.
4646

47-
![Chat](./images/chat.png)
47+
![Chat](/img/about/chat.png)
4848

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

5151
Pull request changes are validated against the linked GitHub or GitLab issue and
5252
identifies all other issues which might be affected by this change.
5353

54-
![Issue Validation](./images/issue-validation.png)
54+
![Issue Validation](/img/about/issue-validation.png)

‎docs/about/images/CodeRabbitFlow.png

-222 KB
Binary file not shown.

‎docs/about/pricing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,15 @@ These are the hourly usage limits for each developer per repository:
7474
- During the trial period, seat assignment is automatic, but the number of seats
7575
can be adjusted when purchasing the subscription.
7676

77-
![Seat Management](./images/cr_seat_manage_dark.png#gh-dark-mode-only)
78-
![Seat Management](./images/cr_seat_manage_light.png#gh-light-mode-only)
77+
![Seat Management](/img/about/cr_seat_manage_dark.png#gh-dark-mode-only)
78+
![Seat Management](/img/about/cr_seat_manage_light.png#gh-light-mode-only)
7979

8080
### Free Plan
8181

8282
- Seats are assigned to new developers immediately
8383

84-
![Free Seat Assignment](./images/cr_seat_free_dark.png#gh-dark-mode-only)
85-
![Free Seat Assignment](./images/cr_seat_free_light.png#gh-light-mode-only)
84+
![Free Seat Assignment](/img/about/cr_seat_free_dark.png#gh-dark-mode-only)
85+
![Free Seat Assignment](/img/about/cr_seat_free_light.png#gh-light-mode-only)
8686

8787
**Note:** The subscription is limited to human users; bot users are not
8888
supported. Thus, pull requests or merge requests created by bots will not be

‎docs/about/support.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Complete the support ticket by providing your name, email, a description of your
2222
issue, and attaching any necessary files. If you are reporting a bug, please
2323
provide the GitHub or GitLab organization name.
2424

25-
![Open a Ticket](./images/cr_support_help_light.png#gh-light-mode-only)
26-
![Open a Ticket](./images/cr_support_help_dark.png#gh-dark-mode-only)
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)
2727

2828
## Email Support
2929

@@ -33,7 +33,7 @@ You can also reach out to us at
3333
:::tip
3434

3535
To see more common issues faced by CodeRabbit users, visit our
36-
[FAQ section](../faq/faq.md) for detailed answers and solutions to frequently
36+
[FAQ section](../faq.md) for detailed answers and solutions to frequently
3737
encountered problems.
3838

3939
:::

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
CodeRabbit offers various configuration options to tailor the reviews to your
66
specific requirements. Configuration can be made using one of the below
77
options.
8-
sidebar_position: 1
8+
sidebar_position: 3
99
---
1010

1111
```mdx-code-block

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

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: FAQs
33
sidebar_label: FAQs
44
description: Frequently asked questions about CodeRabbit.
5+
sidebar_position: 7
56
---
67

78
### General
@@ -37,15 +38,33 @@ uses proprietary code from private repositories for training purposes.
3738
Yes, you can switch between different organizations on CodeRabbit. To do so,
3839
click on the organization name in the top-left corner of the CodeRabbit UI.
3940

40-
![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)
41-
![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)
41+
![Switch Organizations](/img/faq/cr_support_orgs_light.png#gh-light-mode-only)
42+
![Switch Organizations](/img/faq/cr_support_orgs_dark.png#gh-dark-mode-only)
4243

4344
#### What Large Language Models does CodeRabbit use?
4445

4546
CodeRabbit currently utilizes OpenAI's `gpt-4-turbo` and `gpt-3.5-turbo`. We're
4647
researching and testing upcoming LLMs to ensure we're offering the most precise
4748
reviews possible.
4849

50+
#### How does CodeRabbit compare to other AI code generators?
51+
52+
Code reviews remain essential, whether the code is written by a human or a bot.
53+
This is mainly because the perspective of the reviewer differs from that of the
54+
code generator, whether human or machine. This distinction is precisely why
55+
human peer reviews have been effective for so long. While AI-powered
56+
code-generation tools like GitHub Copilot hold immense potential, it's important to recognize that
57+
these generators are still in their early stages and may not be equipped to
58+
auto-generate meaningful code for moderately complex applications.
59+
60+
#### How is CodeRabbit different from other code review tools?
61+
62+
Traditional code review tools excel in linting and static analysis, but they
63+
fall short in providing context-aware, conversational feedback with actionable
64+
suggestions for changes that can be directly committed. On the other hand,
65+
**CodeRabbit** leverages AI to understand the intent behind the code changes and
66+
provide human-like feedback for applying the best practices.
67+
4968
### Subscription
5069

5170
#### Can a CodeRabbit subscription be used across multiple organizations?
@@ -74,7 +93,7 @@ commit after the app is installed. You can, however, use the
7493
#### Can I customize CodeRabbit?
7594

7695
Reviews are customizable. For information, check out our
77-
[Customization](../guides/review-instructions.md) guide.
96+
[Customization](./guides/review-instructions.md) guide.
7897

7998
#### Can I choose a language other than English for the reviews?
8099

@@ -123,7 +142,7 @@ cases, we re-allow further reviews/conversations after a brief timeout.
123142

124143
#### Who can install CodeRabbit on the repositories?
125144

126-
You need to be an admin of the orgnizaation to add the repositories.
145+
You need to be an admin of the organization to add the repositories.
127146

128147
#### I can't add CodeRabbit to my GitLab Repositories. What should I do?
129148

@@ -133,6 +152,6 @@ If there are any access restrictions by domain, then you will need to add
133152
:::tip
134153

135154
If you have further questions or need additional information, please check out
136-
our [Support](../about/support.md) page for more details.
155+
our [Support](./about/support.md) page for more details.
137156

138157
:::

‎docs/guides/_category_.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Guides
2-
position: 3
2+
position: 5
33
collapsible: true
44
collapsed: true

‎docs/guides/delete-account.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ upon selecting **Delete Account**. You can open the dropdowns for more
4343
information.
4444

4545
<div align="center">
46-
![Delete Account](./images/delete_account_light.png#gh-light-mode-only)
47-
![Delete Account](./images/delete_account_dark.png#gh-dark-mode-only)
46+
![Delete Account](/img/guides/delete_account_light.png#gh-light-mode-only)
47+
![Delete Account](/img/guides/delete_account_dark.png#gh-dark-mode-only)
4848
</div>
4949

5050
Deletion will only occur once the admin specifically types in "delete" in the

‎docs/guides/ondemand-reports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Sign in to your CodeRabbit account and navigate to the [**API Keys**](https://ap
2525
Click on the **Create API Key** button and enter a name for the API Key.
2626
Copy the API key, and keep it safe as it won't be visible again.
2727

28-
![API Keys](./images/api_keys.png)
28+
![API Keys](/img/guides/api_keys.png)
2929

3030
## Generate an On-demand report
3131

‎docs/guides/review-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 3
99
---
1010

1111
The guide explains how to add custom review instructions for the entire project.
12-
Also, see the guide on how to [configure CodeRabbit](./configure-coderabbit.md).
12+
Also, see the guide on how to [configure CodeRabbit](../configure-coderabbit.md).
1313

1414
### Path-based instructions {#path-based}
1515

0 commit comments

Comments
 (0)