Skip to content

docs: Introduced Learning page into Docs #362 #413

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 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 2 additions & 0 deletions docs/overview/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,5 @@ For more information, see [Review local changes](/code-editors).
- [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.

- [Start Learning](/overview/learnings/) to dive into hands-on code reviews, practical examples, and lessons from real development workflows.
173 changes: 173 additions & 0 deletions docs/overview/learnings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
---
id: learnings
title: Learnings
sidebar_label: Learnings
sidebar_position: 3
description: Insights and learnings captured from code reviews to enhance future development.
---

# Learnings

At CodeRabbit, every code review isn't just about catching bugs — it's a chance to reflect, improve, and evolve how we write and understand code. This page collects key learnings, helpful resources, and community insights to help you get the most out of CodeRabbit.

---

## 📺 Featured Videos

### 1. Why PR Summaries Matter

Understanding the importance of clear, concise pull-request summaries and how they improve feedback loop quality.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/-KG6lBjIwUw"
title="Why PR Summaries Matter" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 2. PRs That AI Reviews Really Well

See real examples where CodeRabbit delivers accurate and useful insights quickly.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/02iMsze0RRM"
title="PRs AI Reviews Well" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 3. Reviewing open-source: Cal.com

A deep dive into reviewing a complex, real-world open-source project (Cal.com).

<div class="video-container">
<iframe src="https://www.youtube.com/embed/0WmK5QqqjJY"
title="Reviewing Cal.com" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 4. Getting Started with CodeRabbit

Step-by-step walkthrough of installation, setup, and using CodeRabbit on your first PR.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/3SyUOSebG7E"
title="Getting Started" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 5. Reviewing Buildkite’s PR

Insights into how CodeRabbit evaluates CI-oriented codebases like Buildkite.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/ALJZGfPiFnA"
title="Buildkite Review" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 6. How the Cursor Plugin Works

Explore how CodeRabbit integrates into Cursor for in-editor AI feedback.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/bDyhkRZC51E"
title="Cursor Plugin" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 7. Reviewing Code with AI — Vercel

Real-world demo of CodeRabbit understanding and reviewing Vercel-specific code.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/H2xrRByfTZE"
title="Reviewing Vercel Code" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 8. How We Train CodeRabbit

An inside look at the training pipeline, model improvements, and data workflows.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/OhDnoWcUMiw"
title="Training CodeRabbit" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 9. Main AI Podcast: OSS, DevTools

Conversation with engineers on open-source, developer tooling, and the future of AI in code.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/RE2YJGhaqfA"
title="Main AI Podcast" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 10. Reviewing CodeRabbit’s Own Code

A candid walkthrough of CodeRabbit’s internal codebase to show the tool reviewing itself.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/tfy3FdsoUtU"
title="Self Review" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 11. How CodeRabbit Works (Architecture)

Technical overview of our internal architecture and how the system components interact.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/uYPsK0EyAXA"
title="Architecture" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

### 12. Learnings: Code Review Philosophy

Philosophical dive into the core principles, best practices, and mindset behind our code-review approach.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/Yu0cmmOYA-U"
title="CodeRabbit Learnings" frameBorder="0" allowfullscreen>
</iframe>
</div>

---

## 🙌 Final Thoughts

Every interaction with CodeRabbit is an opportunity to learn. Whether you're debugging smarter, catching edge cases faster, or just coding more confidently — this is your space to reflect and grow.

---

## 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.
6 changes: 5 additions & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ const sidebars: SidebarsConfig = {
type: "category",
collapsed: true,
label: "Get started with CodeRabbit",
items: ["overview/introduction", "getting-started/quickstart"],
items: [
"overview/introduction",
"overview/learnings",
"getting-started/quickstart",
],
},
{
type: "category",
Expand Down