Skip to content

Reorganize and expand the Introduction page #297

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.

Sign up for GitHub

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 6 commits into from
Apr 29, 2025
+59 −31
Merged

Reorganize and expand the Introduction page #297

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
967486f
Reorganize and expand the Introduction page, putting more emphasis on…
jmacdotorg Apr 23, 2025
f8250f2
Attending to CR critiques.
jmacdotorg Apr 23, 2025
a9e4e86
More tweaks
jmacdotorg Apr 24, 2025
a8829b5
Swap out imperatve-verb headers (which might accidentally mislead rea…
jmacdotorg Apr 24, 2025
45b3dec
Merge branch 'main' into overview
aravindputrevu Apr 29, 2025
21be545
Remove unnecessary sub-head.
jmacdotorg Apr 29, 2025
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
Attending to CR critiques.
  • Loading branch information
@jmacdotorg
jmacdotorg committed Apr 23, 2025
commit f8250f268cf9d6ac9ca72da3d9bd7b4826e2306e
10 changes: 5 additions & 5 deletions docs/overview/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ slug: "/"

This page provides a conceptual introduction to CodeRabbit. For a hands-on tutorial, see [Quickstart](/getting-started/quickstart/).

## A repsonsive and insightful code reviewer
## A responsive and insightful code reviewer

**CodeRabbit** is an AI-powered code reviewer that delivers context-aware feedback on pull requests within minutes, reducing the time and effort needed for manual code reviews. It complements manual reviews by providing a fresh perspective and catching issues that manual reviews often miss, enhancing the overall review quality.

Developers can interact directly with the CodeRabbit bot within their existing Git platform's pull request interface, in order to add context, ask questions, or even have the bot generate code. Over time, CodeRabbit learns from user input and improves its suggestions.
Developers can interact directly with the CodeRabbit bot within their existing Git platform's pull request interface to add context, ask questions, or even have the bot generate code. Over time, CodeRabbit learns from user input and improves its suggestions.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/3SyUOSebG7E?si=i0oT9RAnH0PW81lY" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen></iframe>
Expand All @@ -33,7 +33,7 @@ Core CodeRabbit features include the following:
- Works with contributors through natural-language conversation in comments.
- Learns and adapts to your team's code style and review preferences.
- Provides an observability dashboard of code-contribution activity.
- Practices strong privacy and security, never retaining your code after reviewing it.
- Practices strong privacy and security, with no retention of analyzed code.
- Free for public repositories, flexible pricing for private code bases.

## Add CodeRabbit to your existing workflow
Expand All @@ -52,13 +52,13 @@ For example, if CodeRabbit uses a linter to suggest that your pull request use f

For a video introduction to this feature, see [CodeRabbit Learnings](https://www.youtube.com/watch?v=Yu0cmmOYA-U).

If you need to fine-tune CodeRabbit's behavior beyond this, then you can [add a CodeRabbit-specific configuration file](getting-started/configure-coderabbit) to your repository, or use the CodeRabbit web UI to set further preferences.
If you need to fine-tune CodeRabbit's behavior beyond this, then you can [add a CodeRabbit-specific configuration file](/getting-started/configure-coderabbit) to your repository, or use the CodeRabbit web UI to set further preferences.

No matter how you tune and customize CodeRabbit, its default settings make it useful out of the box, able to meaningfully review pull requests within minutes of its introduction to a repository.

### Integrate CodeRabbit with your Git platform

CodeRabbit integrates in a just a few clicks with many popular Git platforms:
CodeRabbit integrates in just a few clicks with many popular Git platforms:

- GitHub, including GitHub Enterprise Server
- GitLab, including self-managed GitLab
Expand Down