Skip to content

Commit 34a2934

Browse files
howonleeHowon Lee
and
Howon Lee
authored
Code graph _analysis_ docs (#272)
We agreed in the private slack to call it code graph analysis everywhere. Or at least, we preliminarily agreed on something of that nature. Putting up the docs here until we agree actually Co-authored-by: Howon Lee <[email protected]>
1 parent e4e3fb7 commit 34a2934

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

Diff for: docs/integrations/code-graph-analysis.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Code Graph Analysis
3+
description: Learn about CodeRabbit's intelligent graph-based code analysis.
4+
sidebar_label: Code Graph Analysis
5+
sidebar_position: 6
6+
---
7+
8+
# CodeRabbit Code Graph Analysis
9+
10+
## What is Code Graph Analysis?
11+
12+
Code Graph Analysis is an intelligent code analysis feature that enhances your code reviews by automatically mapping relationships between files in your codebase. By
13+
understanding how your code connects and interacts, Code Graph provides concrete snippets of context that makes reviews more effective and insightful.
14+
15+
## How Code Graph Analysis Enhances Your Reviews
16+
17+
When reviewing code with CodeRabbit, Code Graph Analysis automatically:
18+
19+
- **Maps symbol definitions and references** across your entire codebase
20+
- **Analyzes commit history** to identify files that frequently change together
21+
- **Builds relationship graphs** showing how different parts of your code connect
22+
- **Enriches reviews with contextual information** about related code
23+
24+
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.
25+
26+
## Key Features
27+
28+
### Three Types of Contextual Information
29+
30+
Code Graph Analysis adds three powerful layers of context to your reviews:
31+
32+
1. **Definition Files**: Files containing definitions that are referenced in the current code
33+
2. **Reference Files**: Files that reference symbols defined in the current code
34+
3. **Related Files**: Files that appear related based on usage patterns and commit history
35+
36+
### Language Support
37+
38+
Code Graph Analysis works with:
39+
40+
- Bash
41+
- C
42+
- C#
43+
- C++
44+
- CSS
45+
- Elixir
46+
- Go
47+
- Java
48+
- JavaScript
49+
- Kotlin
50+
- Lua
51+
- PHP
52+
- Python
53+
- Ruby
54+
- Rust
55+
- Scala
56+
- Swift
57+
- TSX
58+
- TypeScript
59+
60+
## Availability
61+
62+
Code Graph Analysis is available on the Lite tier and above.
63+
64+
---
65+
66+
Learn more about CodeRabbit's advanced features at [coderabbit.ai](https://coderabbit.ai)

0 commit comments

Comments
 (0)