.github/workflows/node.js.yaml

@@ -26,6 +26,8 @@ jobs:
           cache: pnpm
       - run: pnpm install --frozen-lockfile --strict-peer-dependencies
       - run: pnpm run build
+        env:
+          API_KEY: ${{ secrets.INKEEP_API_KEY }}
       - run: pnpm run lint
 
   fix:

README.md

@@ -13,7 +13,7 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
 [![Discord](https://img.shields.io/discord/1134356397673414807?color=7289DA&label=Discord&logo=discord&logoColor=green)](http://discord.gg/coderabbit)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/coderabbitai/coderabbit-docs/pulls)
 [![Node.js CI](https://github.com/coderabbitai/coderabbit-docs/actions/workflows/node.js.yaml/badge.svg)](https://github.com/coderabbitai/coderabbit-docs/actions/workflows/node.js.yaml)
-![CodeRabbit Reviews](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.coderabbit.ai%2Fstats%2Fgithub%2Fcoderabbitai%2Fcoderabbit-docs&query=reviews&suffix=%20Reviews&style=flat&label=CodeRabbit&link=https%3A%2F%2Fcoderabbit.ai)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/coderabbitai/coderabbit-docs?labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit%20Reviews)
 
 ## About CodeRabbit
 

docs/changelog.md

@@ -5,6 +5,170 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 13
 ---
 
+## May 19, 2025
+
+### Lua Support with Luacheck
+
+We're excited to announce enhanced support for Lua code analysis with [Luacheck](https://github.com/mpeterv/luacheck), a powerful static analyzer and linter for Lua code.
+
+## May 14, 2025
+
+### CodeRabbit for VS Code, Cursor, and Windsurf Is Here 🎉
+
+We're thrilled to announce that CodeRabbit's AI code reviews have officially landed inside **VS Code and all its forks, including Cursor and Windsurf!** No more review bottlenecks or context switches: now you can get _instant, inline feedback right in your editor, completely free._
+
+**Why you'll love it:**
+
+- 📝 **Inline Code Reviews**: Senior-dev-level annotation on every line. CodeRabbit becomes your AI pair programmer, annotating staged & unstaged commits before you even open a PR.
+- 🚀 **Built for Flow, Not Friction**: Code, review, commit—rise & repeat without breaking your flow state. Reviews run automatically on every commit so you ship faster.
+- 🛠️ **Fix-with-AI**: One-Click Fix for quick tweaks; "Fix with AI" hands off more complex suggestions to your favorite coding agent, complete with full context.
+- 🧩 **Compatible with Cursor, Windsurf & Language-Agnostic**: Works out of the box on VS Code, Cursor, Windsurf. Supports Java, JavaScript, PHP, Python, TypeScript, Go, Ruby, and more.
+
+Pair these IDE-embedded reviews with our deeper Git-platform reviews for a multi-layered approach that catches more bugs and cuts down overall review time.
+
+- [Join the launch discussion on Discord](https://discord.com/channels/1134356397673414807/1145813948193575023/1372210767838842950)
+- [Install the CodeRabbit VSCode Extension](https://coderabbit.link/vscode)
+
+## April 19, 2025
+
+### Docstring Path Instructions
+
+You can now provide path-based instructions for the generation of docstring in `.coderabbit.yaml`.
+
+Example:
+
+```yaml
+code_generation:
+  docstrings:
+    path_instructions:
+      - path: "**/*.ts"
+        instructions: |
+          End all docstrings with a notice that says "Auto-generated by CodeRabbit.".
+          Do not omit the closing tags; the docstring must be valid.
+```
+
+See the [docstrings documentation](/finishing-touches/docstrings#path-instructions) for more details.
+
+## April 14, 2025
+
+### Shopify CLI Integration & Bitbucket Cloud Reporting
+
+We're excited to announce two significant updates:
+
+#### Shopify CLI Integration
+
+We've added support for [Shopify CLI](https://docs.coderabbit.ai/tools/shopify-cli), a powerful tool for validating and analyzing Shopify themes and apps. This integration helps ensure your Shopify projects follow best practices by:
+
+- Validating Liquid syntax and theme requirements
+- Checking app extension configurations
+- Identifying performance bottlenecks
+- Ensuring accessibility standards
+- Detecting security vulnerabilities
+
+#### Bitbucket Cloud Scheduled Reporting
+
+Our reporting capabilities now extend to Bitbucket Cloud! You can now:
+
+- Schedule automated reports for your Bitbucket Cloud repositories
+- Generate customized summaries of team performance
+- Track PR review metrics
+- Deliver reports via Email, Slack, Microsoft Teams, or Discord
+
+## April 11 2025
+
+### Agent Chat
+
+```mdx-code-block
+<ProPlanNotice />
+```
+
+We're thrilled to introduce agentic planning on GitHub for CodeRabbit chat as Generally Available for Pro users. This enhancement lets you make more advanced requests that span multiple files. Just add a review or issue comment on any pull request, or issue comment on an issue, issue tagging `@coderabbitai` along with your natural language request for a code change, and the chat will develop a plan for complex modifications. Upon reviewing the plan and getting your consent, CodeRabbit will emit a stacked PR, commit or copyable snippet to your PR or issue for those code changes.
+
+## April 8, 2025
+
+### New Static Analysis Tools
+
+We've expanded our static analysis capabilities with two new tools:
+
+- **Oxlint**: A high-performance JavaScript/TypeScript linter written in Rust.
+- **Prisma Lint**: A dedicated linter for Prisma schema files to help enforce consistent conventions and best practices.
+
+Both tools can be configured through their respective config files or through CodeRabbit's settings page. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details.
+
+## April 1, 2025
+
+### Code Graph Analysis
+
+Code reviews automatically analyze dependencies across multiple files to enhance the context from code definitions (e.g., types) to improve accuracy and reduce false positives.
+
+This is a very powerful feature that gathers context behind code changes in one file that have dependencies in another file.
+
+🔍 See it in action: Review details → Additional context used → Code definitions
+In the review status message. It is automatically enabled for all users.
+
+### Automatically Run a Web Query to Include Latest Information
+
+CodeRabbit now performs Web Queries automatically to include the most recent publicly available information — even if it wasn't included in the latest LLM update. This feature is enabled by default for all users, and you may notice it being used in review comments and chat responses.
+
+Web Queries allow CodeRabbit to fetch the latest documentation and external content to improve the accuracy and relevance of its output. You can disable this feature by setting web_search: false in your knowledge_base settings.
+
+### CodeRabbit Auto-Resolve
+
+CodeRabbit can now detect when suggested changes have been implemented and automatically resolve the related review threads on your behalf.
+
+### Dashboard Redesign
+
+```mdx-code-block
+import ProPlanNotice from "@site/src/components/ProPlanNotice.mdx"
+
+<ProPlanNotice />
+```
+
+New and Improved Dashboards to provide more useful feedback such as:
+
+- Avgerage PR Merge Time
+- Weekly Pull Request Activity
+- Number of PRs Reviewed
+- Acceptance rate of CodeRabbit Suggestions
+- Tool Findings
+- Review Feedback Breakdown
+
+and much more! Check out the new dashboard to view these metrics about your organization.
+
+### Multi-Step Agent Chat
+
+```mdx-code-block
+<ProPlanNotice />
+```
+
+We're thrilled to introduce agentic planning on GitHub for CodeRabbit chat as an Experimental feature for Early Access users. This enhancement lets you make more advanced requests that span multiple files. Just add a review comment on any pull request tagging `@coderabbitai` along with your natural language request for a code change, and the chat will develop a plan for complex modifications. Upon reviewing the plan and getting your consent, CodeRabbit will emit a stacked PR to your PR for those code changes.
+
+### Additional Static Analysis Support
+
+We are continually expanding our support for static analysis tools. We've recently added support for:
+
+- SQLFluff
+- Added Oxlint for faster linting
+  - Oxlint is a blazingly fast JavaScript/TypeScript linter written in Rust
+  - Replaces ESLint for basic linting while maintaining ESLint for more complex rules
+  - Up to 50-100x faster than traditional ESLint
+
+## February 25, 2025
+
+### Docstrings
+
+```mdx-code-block
+<ProPlanNotice />
+```
+
+We're excited to announce the launch of the Docstrings feature! This functionality allows developers to generate docstrings on a pull request. By commenting `@coderabbitai generate docstrings` on any pull request, you can automatically generate docstrings for functions in the code changes.
+
+The list of supported languages and software forges is available in [the documentation](/finishing-touches/docstrings).
+
+### Azure DevOps Pipeline Failure Detection
+
+We're excited to announce that our pipeline error detection capabilities now extend to Azure DevOps! Just like with GitHub Actions, GitLab CI/CD, and CircleCI, you can now automatically detect and fix pipeline failures in your Azure DevOps pipelines.
+
 ## February 4, 2025
 
 ### Bitbucket Cloud Support & CircleCI Pipeline Failure Detection
@@ -81,7 +245,7 @@ With this update, you can:
 
 ## December 12, 2024
 
-### Docstrings(Beta)
+### Docstrings (Beta)
 
 We have launched a new functionality as part of our finishing touches initiative to allow developers to generate docstrings on a pull request. This feature lets you generate docstrings by commenting `@coderabbitai generate docstrings` on any pull request. This works for both new and existing documentation. See [our documentation](https://docs.coderabbit.ai/finishing-touches/docstrings) for details.
 

docs/faq.md

@@ -31,10 +31,10 @@ CodeRabbit works with all programming languages, with varying proficiency based
 
 <Tabs>
   <TabItem value="storage" label="Code Storage" default>
-    - No persistent code storage
-    - Temporary cloning during review only
     - Complete data isolation
-    - Immediate disposal post-review
+    - Caching of encrypted code and dependency archives for faster reviews
+    - Code indexing in which we store vector representations of code for efficient code base context
+    - Both caching and code indexing can be disabled which means we store nothing post-review
   </TabItem>
   <TabItem value="training" label="Training Data">
     - Uses only public datasets
@@ -92,7 +92,7 @@ Email field and click Update to save your changes.
 ### Usage and Configuration
 
 - **Language Settings**: Configure review language in repository settings
-- **Review Rules**: Customize via [Review Instructions](/guides/review-instructions)
+- **Review Rules**: Customize via [review instructions](/guides/review-instructions)
 - **Branch Selection**: Default branch reviews enabled by default (configurable)
 
 ### Access & Permissions
@@ -108,7 +108,7 @@ Interact with CodeRabbit by:
 1. Replying directly to CodeRabbit comments
 2. Tagging `@coderabbitai` in PR discussions
 3. Adding review comments for specific lines
-4. Customize via [Review Instructions](/guides/review-instructions)
+4. Customize via [review instructions](/guides/review-instructions)
 
 :::tip Collaboration Mode
 When team members are active in PRs, use `@coderabbitai` to engage the bot.
@@ -128,7 +128,7 @@ The following limits enforced _per developer_:
 | ---------------- | ------------------------------------------ | ----------------------------- | ----------------------------- | ----------------------------- |
 | Files per hour   | 200/hour                                   | 200/hour                      | 200/hour                      | 400/hour                      |
 | Files per PR     | 100                                        | 100                           | 100                           | 200                           |
-| Reviews per hour | 3 back-to-back, then 3/hour (Summary only) | 3 back-to-back, then 3/hour   | 2 back-to-back, then 2/hour   | 4 back-to-back, then 4/hour   |
+| Reviews per hour | 3 back-to-back, then 3/hour (Summary only) | 4 back-to-back, then 4/hour   | 3 back-to-back, then 3/hour   | 5 back-to-back, then 5/hour   |
 | Chat             | N/A                                        | 25 back-to-back, then 50/hour | 10 back-to-back, then 25/hour | 25 back-to-back, then 50/hour |
 
 ## Integration Guide {#integration-guide}
@@ -254,6 +254,11 @@ A confirmation modal will appear explaining the consequences of account deletion
     2. Delete CodeRabbit webhooks
     3. Remove CodeRabbit user or delete associated Personal Access Token
   </TabItem>
+  <TabItem value="bitbucket" label="Bitbucket Cleanup">
+    1. Go to Project Settings > Webhooks
+    2. Delete CodeRabbit webhooks
+    3. Remove CodeRabbit user or delete associated App Passwords
+  </TabItem>
 </Tabs>
 
 :::warning Post-Deletion Steps

docs/finishing-touches/docstrings.md

@@ -1,6 +1,5 @@
 ---
-title: Docstrings generation with CodeRabbit
-sidebar_label: Docstrings (Beta)
+title: Generate docstrings
 description: Automated docstrings pull requests with CodeRabbit
 ---
 
@@ -14,12 +13,6 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
 
 Docstrings generation is part of the [finishing touches](/future-development#finishing-touches).
 
-:::info
-
-This feature is in [beta](/early-access#beta).
-
-:::
-
 ## Usage
 
 Once you are done with your pull request and its reviews, you may want to perform finishing touches to your code, such as adding in-code documentation. You can request CodeRabbit to generate docstrings by typing `@coderabbitai generate docstrings` in a comment under that pull request.
@@ -37,27 +30,42 @@ Here's an example of what a pull request may look like:
 
 CodeRabbit cannot perform further modifications to opened pull requests. From there, it's your turn to checkout the branch and improve it to satisfaction. We believe that this workflow provides a significant headstart to documenting code.
 
-We are testing this workflow internally to adjust the prompts, add more supported software forges, add more supported languages and craft an excellent user experience. However, you can use this preview and enjoy a sneak peek at the future of CodeRabbit. Additionally, you can provide feedback about this feature on [Discord](https://discord.com/channels/1134356397673414807/1317286905557287022).
+This feature has been rigorously tested and is now available for all Pro plan users. Additionally, you can provide feedback about this feature on [Discord](https://discord.com/channels/1134356397673414807/1317286905557287022).
+
+## Path Instructions
+
+You can customize the generated docstrings by providing instructions based on file paths in your `.coderabbit.yaml`. The `path` is a [minimatch](https://github.com/isaacs/minimatch) pattern.
+
+```yaml
+code_generation:
+  docstrings:
+    path_instructions:
+      - path: "**/*.ts"
+        instructions: |
+          End all docstrings with a notice that says "Auto-generated by CodeRabbit.".
+          Do not omit the closing tags; the docstring must be valid.
+```
 
 ## Supported software forges
 
-The checked software forges are supported:
+These software forges are supported:
 
-- [ ] Azure DevOps
-- [ ] Bitbucket
+- [x] Azure DevOps
+- [ ] Bitbucket Cloud
+- [ ] Bitbucket Data Center
 - [x] GitHub
-- [ ] GitLab
+- [x] GitLab
 
-The presence of an unsupported software forge in this list does not constitute a commitment to support it in the future. Remember that the docstrings feature is in [beta](/early-access#beta).
+While Bitbucket is not officially supported, docstrings can still be generated. However, they will be posted in a comment under the pull request. Full support for Bitbucket is planned.
 
 ## Supported languages
 
-The checked languages are supported:
+These languages are supported:
 
 - [x] Bash
 - [x] C
-- [x] C++
 - [x] C#
+- [x] C++
 - [x] Elixir
 - [x] Go
 - [ ] Haskell
@@ -74,8 +82,4 @@ The checked languages are supported:
 - [x] Swift
 - [x] TypeScript
 
-The presence of an unsupported language in this list does not constitute a commitment to support it in the future. Remember that the docstrings feature is in [beta](/early-access#beta).
-
-:::note
-In the case of JavaScript and TypeScript and the React versions of both, there are tons of ways to declare functions. At the moment, we only support the keyword `function` at the top level.
-:::
+CodeRabbit uses `ast-grep` to parse the code. If you want a new language to be supported, please look into [Add New Language to ast-grep](https://ast-grep.github.io/contributing/add-lang.html#add-new-language-to-ast-grep) first.

docs/getting-started/adding-organizations.md

@@ -1,8 +1,6 @@
 ---
-title: Adding Organizations
+title: Add organizations
 description: Learn how to add new organizations to CodeRabbit
-sidebar_label: Adding Organizations
-sidebar_position: 5
 ---
 
 To add new organizations to CodeRabbit, follow these steps:

docs/getting-started/configure-coderabbit.md

@@ -1,11 +1,9 @@
 ---
-title: Configure CodeRabbit
-sidebar_label: Configure
+title: Add a configuration file
 description:
   CodeRabbit offers various configuration options to tailor the reviews to your
   specific requirements. Configuration can be made using one of the below
   options.
-sidebar_position: 2
 ---
 
 ```mdx-code-block