This repository was archived by the owner on Aug 16, 2025. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork 70
update: introduction, added a CTA and improved image SEO#108
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
175 commits Select commit Hold shift + click to select a range
1850560 Coderabbit Docs Rework (wip)
karan925 5a428da WIP blog page
karan925 6f6cbba Fixed images
karan925 437f0c1 Wip added all blogs and docs
karan925 659543e ✏️ Remove asterisk from CodeRabbit heading
karan925 457b050 Add Tailwind CSS configuration and update page title
karan925 1921f66 Update logo href and navbar styling
karan925 12fac5d Update Docusaurus configuration and custom CSS
karan925 e81cb5c Update routing and styling
karan925 2eb8767 Add sitemap configuration and update redirect paths
karan925 0c1e382 blog: cost effective generative ai app
gitcommitshow 962456e fix: numbering
gitcommitshow f20540c Update CodeRabbit links in documentation
karan925 3992b66 Update CodeRabbit documentation
karan925 7488bbf Update base URL and redirect to external documentation
karan925 659c010 Update links to Get Started page
karan925 7e045cf Add new images and update links in docusaurus.config.ts and sidebars.ts
karan925 0f274d9 Add redirect to documentation page
karan925 ad69816 Update slug in introduction.md
karan925 7632346 Update introduction.md and docusaurus.config.ts, delete index.tsx
karan925 48a85c3 Add code to change the docs link on the navbar
karan925 d3a5ff7 Remove unnecessary code and add redirect for docs
karan925 d117978 Update docs link and hide SVG icon
karan925 97213cc Adjustments for mobile view in custom.css
karan925 f912e24 Update logo size and padding for smaller screens, center Discord link…
karan925 0b913d7 Update image paths in CodeRabbit deep dive blog post
karan925 4133ff0 Update image in introduction.md
karan925 ea1d09b Update image URL in blog post
karan925 de40cf1 Update favicon links in blog post
karan925 34c9de0 Update og:image URL in blog post
karan925 0319500 Update blog post image URLs
karan925 265cb7c Update image URLs in blog posts
karan925 e08f048 feat: added document under integration on integration with self hoste…
coderabbit-amank 308e940 Update docs/integrations/self-hosted-gitlab.md
guritfaq 5844da6 Update docs/integrations/self-hosted-gitlab.md
guritfaq b1f719e Update docs/integrations/self-hosted-gitlab.md
guritfaq aac251d Update docs/integrations/self-hosted-gitlab.md
guritfaq 424b4df Update docs/integrations/self-hosted-gitlab.md
guritfaq 57f71ea Update docs/integrations/self-hosted-gitlab.md
guritfaq 4823be9 Update docs/integrations/self-hosted-gitlab.md
guritfaq 7bbafd9 Update self-hosted-gitlab.md
guritfaq 758c852 blog: modern ai stack for devs
gitcommitshow d5c42f9 citation: codex model use in gh copilot
gitcommitshow b4efe86 fix: gh citation link
gitcommitshow 26ae895 fix: typo
gitcommitshow cc70c22 fix: typo
gitcommitshow 5992c58 Update index.md
guritfaq a38fb93 founderblogmissing
guritfaq 9a7f9cc Remove markdown file
karan925 ad174bf Update CodeRabbit description and add privacy and security information
karan925 c11119f Update link in introduction.md
karan925 8bb8509 nit
guritfaq 7ac40ec Add new images and delete old image files
karan925 feb4945 Update self-hosted-gitlab.md
guritfaq 4f7c49f Update customize-coderabbit.md
guritfaq 77c3494 Update self-hosted-gitlab.md
guritfaq e3401f6 Update customize-coderabbit.md
guritfaq d14ec26 format blog file
harjotgill ff65901 format all blog files
harjotgill 64b3808 hide version 1 schema
harjotgill 8073a01 Update faq.md
guritfaq 533af1e Fix images for light and dark mode. Made improvements to docs (#22)
karan925 bb33250 Add ast-grep documentation page
petrisorcoderabbit 555f1b3 Update the ast-grep documentation to include the coderabbit config fi…
petrisorcoderabbit 6ff0b6f Fix language review
petrisorcoderabbit 7e94e24 Update coderabbit.yaml schema for ast-grep tool naming
petrisorcoderabbit 69ad5db Update coderabbig guide page with new coderabbit.yaml changes
petrisorcoderabbit 2b93fa1 Update 2023-11-13-boosting-engineering-efficiency.md
guritfaq e95932f Move ast-grep documentation under the prompt-customization page
petrisorcoderabbit 02fb676 Change ast-grep naming
petrisorcoderabbit bfbeb10 Correct grammar for ast-grep documentation
petrisorcoderabbit 907acba update faqs
karan925 75cd0b6 restructure existing blog posts
harjotgill f40402a Add ast-grep documentation page
petrisorcoderabbit afc74b9 Update the ast-grep documentation to include the coderabbit config fi…
petrisorcoderabbit 376b918 Fix language review
petrisorcoderabbit d8c6d90 Update coderabbit.yaml schema for ast-grep tool naming
petrisorcoderabbit 174f510 Move ast-grep documentation under the prompt-customization page
petrisorcoderabbit e36c04b restructure existing docs
harjotgill 4d1ce4a review feedback
harjotgill 05a1cf1 add preview image
harjotgill 1b14bb0 use directory instead of folder terminology
harjotgill 4472fbc nit
harjotgill 31043f7 add disqus comments
harjotgill 154f910 fix admonitions
harjotgill 69bf8c8 add fn acquisition blog (#27)
harjotgill 0b206a4 update preview image
harjotgill 4026e5c update preview image
harjotgill b04bb86 minor update to the FAQ
harjotgill 20ccaf0 Daily Standup Reporting Docs (#28)
Spikatrix 1ddc296 Add packages section and update existing docs for ast-grep (#29)
petrisorcoderabbit 7c0e821 updateschemaexample (#31)
guritfaq a2c5390 minorchanges (#32)
guritfaq ff0241b updatefaq
guritfaq 4f6b57b FAQs
guritfaq 69701dd doc fixes (#33)
harjotgill 654c2f4 fix path instructions example
harjotgill 34e75c3 change the default example for coderabbit yaml
harjotgill f2dceee Blog - AI Code Reviews (#36)
guritfaq 436179d update example
harjotgill eed94ff blog home page
harjotgill 22af9a8 blog featured posts
harjotgill e0304d2 AdminAccessToken
guritfaq 4ca41ce FixCasing
guritfaq 8d52595 updatecasing
guritfaq 6e9350e update docs
harjotgill 429d8d9 update schema
harjotgill 9f11153 remove daily standup guide
harjotgill a720cb7 Update YAML settings in configure-coderabbit.md (#40)
hasit 94aeaaa update pricing
harjotgill ba3e35e remove pnpm
harjotgill 08cdcbe ast-grep update
harjotgill 7845092 update knowledge_base settings
harjotgill b38424f mention ast-grep-essentials
harjotgill c905756 add review.profile to docs
harjotgill 6d823bd update review status
harjotgill 7d380fa revert review status change
harjotgill 139a917 add quotes
harjotgill fa74e88 minor
harjotgill a65da37 improve config docs
harjotgill f7402d4 add playground link
harjotgill 2c3f4a0 placeholder for high-level summary
harjotgill 7ab287f remove v1 config documentation
harjotgill 3495248 remove ignore title example
harjotgill 530acb0 remove ignore title example
harjotgill 826beb8 UpatePauseCommandMessage
guritfaq 2f21f51 update docs
harjotgill 006a15c Update introduction.md
guritfaq 6933e31 Add config for biome and hadolint (#43)
hasit 8730b48 update auto_incremental_review
harjotgill 415c56c improve config docs
harjotgill e8ff3c1 chore: Update CodeRabbit configuration settings (#44)
hasit 1d5c297 chore: Add config for new tools (#45)
hasit 8fadbaa UpdateDataPrivacy
guritfaq 28c2abd chore: Update SwiftLint configuration file path (#47)
hasit d3d8b6a Update self hosted onboarding guide
petrisorcoderabbit 5a6b336 update auto title
harjotgill 9c6f5cf update phpstan instructions
harjotgill 678216a Update npm dependencies and add docusaurus-json-schema-plugin (#49)
hasit a527fc5 Update faqs typos (#51)
karan925 8c8162b update docs
harjotgill d10046a Create initial Gitlab Saas integration page
petrisorcoderabbit 16b5f88 Update GitLab page content on the how to section with a note
petrisorcoderabbit 4ae6960 add tip
harjotgill a9eace3 update limits
harjotgill ebaa1cf 📝 Add Documentation for Deleting Account (#55)
karan925 9847324 On-demand report generation docs (#56)
Spikatrix a55b5d1 Add linter documentation (#59)
hasit 63f51d3 Update tool configuration documentation (#60)
hasit 3b2576d Update Gitleaks documentation (#61)
hasit 0f312bf Update introduction.md and add video (#62)
hasit 231e38a Add table for Supported Tools by languages (#63)
hasit dc7179d Update introduction and CodeRabbit documentation (#64)
hasit 24801d8 Update default settings for CodeRabbit tools (#65)
hasit e5e33a0 feat: added docs for detekt and eslint (#67)
cr-ruhanmuzaffar 3c1af49 Add segment script and update iframe attributes for YouTube video pla…
hasit 58519eb Improve Documentation Structure and Accessibility in Markdown Files (…
hasit 9dbdc24 Self-Hosted GitHub onboarding docs (#66)
Spikatrix a9210c6 Add step to install GitHub App for Self-Hosted (#70)
Spikatrix 3d93378 Remove ESLint from JavaScript tools documentation (#71)
hasit e2efc2a Add supported git platforms page in documentation (#72)
hasit 6961118 added yaml editor (#74)
cr-ruhanmuzaffar 670882d Feature yaml editor (#76)
cr-ruhanmuzaffar 56a09eb Update schema.v2.json
github-actions[bot] 3d5156d 🎨 Run Markdownlint and Prettier (#84)
NatoBoram 4d6f0c8 added correct scopes (#88)
dikshant-infracloud a9d57be Add Azure DevOps initial docs page
petrisorcoderabbit d214b38 Update Azure DevOps
guritfaq 6e7ab40 add redirect
guritfaq ea198f7 rename AzureDevOps page
guritfaq d84bbed SaaS GitLab change to Gitlab.com and added relevant redirect Update G…
aravindputrevu e434cc0 Azure DevOps Server Support
guritfaq a8dad85 Update platforms.md
NickBusey aaab99e Remove segment (#104)
hasit 691b19e update: introduction and added a CTA
tyaga001 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,63 @@ | ||
| --- | ||
| id: introduction | ||
| title: Introduction | ||
| id: Get Started | ||
| title: Get Started | ||
| sidebar_label: Introduction | ||
| sidebar_position: 1 | ||
| description: | ||
| CodeRabbit is an innovative, AI-powered code reviewer. It provides context-aware | ||
| review feedback on a pull request within minutes, thereby significantly | ||
| reducing the time and effort associated with manual code reviews. | ||
| CodeRabbit is an AI-powered code reviewer offering real-time, context-aware | ||
| feedback on pull requests, reducing manual effort in code reviews. | ||
| slug: "/" | ||
| --- | ||
| ## What is CodeRabbit? | ||
| >**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 provides a fresh perspective and catches issues that are often missed, enhancing the overall review quality. | ||
| Developers can interact directly with the bot within the code, offering additional context, asking questions, or even having the bot generate code. Over time, **CodeRabbit** learns from user input and improves its suggestions. | ||
| :::tip | ||
| > See CodeRabbit in action and watch the demo video below to see how it delivers real-time, context-aware feedback on your pull requests in just a few minutes. | ||
| ::: | ||
| <divclass="video-container"> | ||
| <iframesrc="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> | ||
| **CodeRabbit** is an innovative, AI-powered code reviewer. It provides | ||
| context-aware review feedback on a pull request within minutes, thereby | ||
| significantly reducing the time and effort associated with manual code reviews. | ||
| Additionally, it brings a different perspective to the reviews and finds issues | ||
| often missed by the human eye. Developers can chat with the bot within the code, | ||
| which allows them to provide additional context, ask questions, or have the bot | ||
| generate code. It learns from your suggestions and gets better over time. | ||
| **CodeRabbit** seamlessly integrates with GitHub and GitLab repositories, | ||
| performing continuous, incremental reviews for each commit within a pull | ||
| request. Review feedback is sent back to the pull requests and can be directly | ||
| committed. | ||
| **CodeRabbit** integrates into code repositories using GitHub or GitLab webhooks | ||
| and monitors events related to Pull Request (PR) and Merge Request (MR) changes. | ||
| A comprehensive review is performed when a PR or MR is created, and for | ||
| incremental commits and comments addressed to the bot. The feedback is then sent | ||
| directly back to the PR or MR. | ||
|  | ||
| ## Data, Privacy, and Security | ||
| **CodeRabbit** does not use data collected during code reviews to train or | ||
| influence the models. Queries to the Large Language Models (LLMs) are ephemeral | ||
| and there is zero retention on LLMs. Neither we nor the LLMs provider(s) share | ||
| any data collected during the code review process with third parties. | ||
| Data storage: Code downloaded during the review process is temporarily stored in | ||
| memory and deleted once the review is completed. The code is not stored or used for | ||
| any other purpose. However, CodeRabbit enhances future reviews for your organization by | ||
| storing the embeddings of the learnings generated from chat conversations. Additionally, | ||
| it integrates embeddings from issues in workflow systems (Linear, Jira, GitHub/GitLab issues) | ||
| to assess the impact of code changes on existing issues. | ||
| Compliance and Data Privacy: Your data is kept confidential, isolated by the | ||
| organization, and used only to improve your organization reviews. Data storage | ||
| complies with SOC2 Type II and GDPR standards. | ||
| Opting Out: You can choose to opt out of data storage at any time. Opting out | ||
| won't affect your access but will limit the personalization of the reviews. | ||
| ## Integration with GitHub and GitLab | ||
| >**CodeRabbit** integrates with both GitHub and GitLab repositories to deliver continuous and incremental reviews for each commit in a pull request (PR) or merge request (MR). Review feedback is automatically sent back to the PR/MR and can be committed directly. | ||
| It works via GitHub/GitLab webhooks, monitoring Pull Request (PR) and Merge Request (MR) events. A comprehensive review is performed when a PR or MR is created, and for | ||
| incremental commits and comments addressed to the bot. The feedback is then sent directly back to the Pull Request or Merge Request. | ||
|  | ||
| ## Data Privacy and Security | ||
| >**CodeRabbit** does not use data collected from code reviews to train or influence its models. All queries to Large Language Models (LLMs) are ephemeral, with zero retention. No data is shared with third parties. | ||
| -**Temporary Storage**: Code is temporarily stored in memory during the review process and deleted afterward. | ||
| -**Stored Embeddings**: While the code itself isn’t stored, **CodeRabbit** stores embeddings based on chat conversations and workflow systems (Linear, Jira, GitHub/GitLab issues) to improve future reviews. | ||
| -**Compliance**: All data is kept confidential, isolated by organization, and complies with **SOC2 Type II** and **GDPR** standards. | ||
| ### Opting Out | ||
| You can opt out of data storage at any time without affecting your access to **CodeRabbit**. | ||
| :::warning | ||
| However, opting out may reduce the level of personalized review feedback. | ||
| ::: | ||
| ## Try CodeRabbit Now | ||
| >Ready to experience **CodeRabbit** in action? | ||
| :::tip | ||
| For open source projects CodeRabbit Pro is **_FREE_**, forever. | ||
| - No credit card required | ||
| - Unlimited public repositories | ||
| ::: | ||
| <divstyle={{textAlign:'left',marginTop:'20px'}}> | ||
| <ahref="https://app.coderabbit.ai/login"className="button button--primary button--lg">Start reviewing PR Now</a> | ||
| </div> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Effective "Try CodeRabbit Now" section with clear CTA
The new "Try CodeRabbit Now" section is a great addition that aligns with the PR objective of adding a CTA. It effectively encourages users to try the product, highlighting the free offering for open source projects. The CTA button is clear and prominent.
There's a minor formatting issue with the list items. To fix this, add a blank line before the list:
For open source projects CodeRabbit Pro is **_FREE_**, forever. - No credit card required - Unlimited public repositories + :::This change will ensure proper rendering of the list items in the final output.
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool
🪛 Markdownlint