Skip to content

Fix images for light and dark mode. Made improvements to docs #22

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.

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 7 commits into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Update support and add-repo documentation
  • Loading branch information
karan925 committed Mar 12, 2024
commit a64d35cc0b93fb5f24bc2c3648a6aab044d824d7
4 changes: 2 additions & 2 deletions docs/about/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ Complete the support ticket by providing your name, email, a description of your
![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)

### Explore More

:::tip
To see more common issues faced by CodeRabbit users, visit our FAQ section for detailed answers and solutions to frequently encountered problems.
:::

### **Community Collaboration**

Expand Down
4 changes: 2 additions & 2 deletions docs/get-started/add-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ To add additional repositories after the sign-up, go to the repositories page wi
Click on the "**Add repositories**" button. Upon clicking, you'll be redirected to GitHub.

![AddRepo](./images/cr_add_repo_light.png#gh-light-mode-only)

<!-- ![AddRepo](./images/cr_add_repo_light.png#gh-light-mode-only) -->
![AddRepo](./images/cr_add_repo_dark.png#gh-dark-mode-only)

Upon successful installation, you will be automatically redirected back to the CodeRabbit UI. Here, you can view the list of repositories that CodeRabbit now has access to.

Expand All @@ -39,6 +38,7 @@ Upon successful installation, you will be automatically redirected back to the C
For **GitLab** the flow is slightly different. All the repositories display by default and you can toggle and enable the ones where the CodeRabbit app should be installed.

![AddRepo](./images/cr_add_repo_gitlab_light.png#gh-light-mode-only)
![AddRepo](./images/cr_add_repo_gitlab_dark.png#gh-dark-mode-only)

:::

Expand Down
11 changes: 7 additions & 4 deletions docs/get-started/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ slug: /dashboard
description: Accelerate Code Reviews with AI
image: "/preview_meta.jpg"
---

<head>
<meta charSet="utf-8" />
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
Expand All @@ -22,19 +23,21 @@ image: "/preview_meta.jpg"
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
</head>

CodeRabbit Dashboard displays organization's pull request activity and value provided by CodeRabbit reviews. This includes the number of pull requests reviewed, actionable items,optional comments and more.
CodeRabbit Dashboard displays organization's pull request activity and value provided by CodeRabbit reviews. This includes the number of pull requests reviewed, actionable items,optional comments and more.

Dashboard displays the following information:

- **Pull Requests Overview:** View the number of pull requests reviewed by CodeRabbit per week, month, and year.
- **CodeRabbit's Activity:** Understand the metrics related to the number of reviews conducted by CodeRabbit, actionable items, and optional suggestions.

![Untitled](./images/analytic2.png)
![Untitled](./images/cr_dash_dark.png#gh-dark-mode-only)
![Untitled](./images/cr_dash_light.png#gh-light-mode-only)

Access the list of recent pull request reviewed.

![Untitled](./images/analytic3.png)
![Untitled](./images/cr_history_dark.png#gh-dark-mode-only)
![Untitled](./images/cr_history_light.png#gh-light-mode-only)

### **Need help?**

If you require assistance, our support team is here to help. Simply click on the help icon within the CodeRabbit user interface. For more detailed information, please refer to the "Support" section. Additionally, consider joining the CodeRabbit Discord community to connect with other users and access a wealth of knowledge about using CodeRabbit effectively.
If you require assistance, our support team is here to help. Simply click on the help icon within the CodeRabbit user interface. For more detailed information, please refer to the "Support" section. Additionally, consider joining the CodeRabbit Discord community to connect with other users and access a wealth of knowledge about using CodeRabbit effectively.
Binary file removed docs/get-started/images/add1.png
Binary file not shown.
Binary file removed docs/get-started/images/add4.png
Binary file not shown.
Binary file removed docs/get-started/images/analytic2.png
Binary file not shown.
Binary file removed docs/get-started/images/analytic3.png
Binary file not shown.
Binary file added docs/get-started/images/cr_add_repo_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-started/images/cr_dash_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-started/images/cr_dash_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-started/images/cr_history_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-started/images/cr_history_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.