Skip to content

Code graph docs, preliminary #269

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

Closed
wants to merge 6 commits into from
Closed
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
cga
  • Loading branch information
Howon Lee committed Apr 8, 2025
commit 6bc9112f5ca02d4c90d75cb08a767998eb212f85
Original file line number Diff line number Diff line change
@@ -1,39 +1,41 @@
---
title: Code Graph
title: Code Graph Analysis
description: Learn about CodeRabbit's intelligent graph-based code analysis.
sidebar_label: Code Graph
sidebar_label: Code Graph Analysis
sidebar_position: 6
---

# CodeRabbit Code Graph
# CodeRabbit Code Graph Analysis

## What is Code Graph?
## What is Code Graph Analysis?

Code Graph is an intelligent code analysis feature that enhances your code reviews by automatically mapping relationships between files in your codebase. By
Code Graph Analysis is an intelligent code analysis feature that enhances your code reviews by automatically mapping relationships between files in your codebase. By
understanding how your code connects and interacts, Code Graph provides concrete snippets of context that makes reviews more effective and insightful.

## How Code Graph Enhances Your Reviews
## How Code Graph Analysis Enhances Your Reviews

When reviewing code with CodeRabbit, Code Graph automatically:
When reviewing code with CodeRabbit, Code Graph Analysis automatically:

- **Maps symbol definitions and references** across your entire codebase
- **Analyzes commit history** to identify files that frequently change together
- **Builds relationship graphs** showing how different parts of your code connect
- **Enriches reviews with contextual information** about related code

Code Graph Analysis is also available in the CodeRabbit Chat. CodeRabbit Chat will automatically analyze your codebase with it when the agent deems it necessary.

## Key Features

### Three Types of Contextual Information

Code Graph adds three powerful layers of context to your reviews:
Code Graph Analysis adds three powerful layers of context to your reviews:

1. **Definition Files**: Files containing definitions that are referenced in the current code
2. **Reference Files**: Files that reference symbols defined in the current code
3. **Related Files**: Files that appear related based on usage patterns and commit history

### Language Support

Code Graph works with:
Code Graph Analysis works with:

- Bash
- C
Expand All @@ -57,7 +59,7 @@ Code Graph works with:

## Availability

Code Graph is available on the Lite tier and above.
Code Graph Analysis is available on the Lite tier and above.

---

Expand Down