Skip to content

docs: Refactor documentation to use Markdown with CSS-based components #467

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
docs: optimized the styles of all the Admonitions (#438)
  • Loading branch information
Prasad Bhat authored and Prasad Bhat committed Jul 24, 2025
commit 89b3ae1f6ffcf625a825f5edebcaee917ce9946c
62 changes: 13 additions & 49 deletions docs/overview/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ description:
slug: "/"
---


# Introduction

This page provides a conceptual introduction to CodeRabbit. For a hands-on tutorial, see [Quickstart](/getting-started/quickstart/).
Expand All @@ -19,14 +18,7 @@ This page provides a conceptual introduction to CodeRabbit. For a hands-on tutor
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>
<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>
</div>

## Core features
Expand Down Expand Up @@ -66,48 +58,21 @@ No matter how you tune and customize CodeRabbit, its default settings make it us

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

<div class="platform-integration-grid">
<div class="platform-integration-card">
<img class="platform-integration-icon" src="/img/overview/Github.png" alt="GitHub, including GitHub Enterprise Server" />
<span>GitHub, including GitHub Enterprise Server</span>
</div>
<div class="platform-integration-card">
<img class="platform-integration-icon" src="/img/overview/Gitlab.png" alt="GitLab, including self-managed GitLab" />
<span>GitLab, including self-managed GitLab</span>
</div>
<div class="platform-integration-card">
<img class="platform-integration-icon" src="/img/overview/Bitbucket.png" alt="Bitbucket Cloud" />
<span>Bitbucket Cloud</span>
</div>
<div class="platform-integration-card">
<img class="platform-integration-icon" src="/img/overview/Azure.png" alt="Azure DevOps" />
<span>Azure DevOps</span>
</div>
</div>
- GitHub, GitHub Enterprise Cloud, GitHub Enterprise Server,
- GitLab, GitLab Self-Managed
- Azure DevOps
- Bitbucket Cloud

For more information, see [Supported Git Platforms](/platforms/).

### Issue-management integration

You can integrate CodeRabbit with issue-management platforms. This lets you ask CodeRabbit to create tickets during code reviews, or chat with CodeRabbit about your code from within issue comments. Compatible platforms include the following:

<div class="platform-integration-grid">
<div class="platform-integration-card">
<img class="platform-integration-icon" src="img/overview/Github.png" alt="GitHub Issues" />
<span>GitHub Issues</span>
</div>
<div class="platform-integration-card">
<img class="platform-integration-icon" src="img/overview/Gitlab.png" alt="GitLab Issues" />
<span>GitLab Issues</span>
</div>
<div class="platform-integration-card">
<img class="platform-integration-icon" src="img/overview/Jira.png" alt="Jira" />
<span>Jira</span>
</div>
<div class="platform-integration-card">
<img class="platform-integration-icon" src="img/overview/Linear.png" alt="Linear" />
<span>Linear</span>
</div>
</div>
- GitHub Issues
- GitLab Issues
- Jira
- Linear

For more information, see [Issue Creation](/guides/issue-creation) and [Issue Chat](/guides/issue-chat).

Expand All @@ -118,7 +83,6 @@ CodeRabbit collects only the minimum amount of information needed to provide you
- All queries to large language models (LLMs) exist in-memory only, with zero retention after each query completes.
- We don't use your code, code reviews, or other collected data to train LLMs.
- CodeRabbit doesn't share any collected customer data with third parties.
- Works with contributors through natural-language conversation in comments.
- We keep all customer data confidential, and isolated by organization.
- Our data collection and storage practices comply with SOC 2 and GDPR standards.

Expand All @@ -128,9 +92,7 @@ For more information about how we protect your data, see [the CodeRabbit Trust C

Public repositories can use the Pro tier of CodeRabbit at no charge, including all of the code-review features described on this page. Rate limits might apply.

For private repositories, a number of pricing tiers are available. These range from a Free tier that offers unlimited code-change summaries, to an Enterprise tier with access to advanced features and SLA support.

For more information, see [Pricing](https://www.coderabbit.ai/pricing).
For private repositories, a number of pricing tiers are available. These range from a Free tier that offers unlimited code-change summaries, to an Enterprise tier with access to advanced features and SLA support. For more information, see [Pricing](https://www.coderabbit.ai/pricing).

## Review local changes from within VSCode

Expand All @@ -141,5 +103,7 @@ For more information, see [Review local changes](/code-editors).
## What's next

- [Quickstart](/getting-started/quickstart/) lets you experience your first CodeRabbit code review first-hand.

- [Review local changes](/code-editors) guides you through installing and using a subset of CodeRabbit features directly from your code editor.

- [Why CodeRabbit?](/overview/why-coderabbit) dives further into the philosophies and technologies that drive CodeRabbit.
Loading
Loading