coderabbitai · edgarcerecerez · Jul 31, 2025
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -0,0 +1,91 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is the CodeRabbit documentation site built with Docusaurus v3. The site is live at https://docs.coderabbit.ai/ and provides comprehensive documentation for CodeRabbit, an AI-powered code review tool.
+
+## Essential Commands
+
+```bash
+# Development (MUST use pnpm)
+pnpm install        # Install dependencies
+pnpm start          # Start dev server at localhost:3000
+pnpm build          # Build for production
+pnpm serve          # Serve production build locally
+
+# Code Quality
+pnpm lint           # Check markdown and formatting
+pnpm lint:fix       # Auto-fix issues
+pnpm format         # Format all files
+pnpm typecheck      # TypeScript type checking
+
+# Cleanup
+pnpm clean          # Remove build artifacts and node_modules
+pnpm clear          # Clear Docusaurus cache
+```
+
+## Architecture & Key Concepts
+
+### Documentation Structure
+
+- `/docs/` - All documentation content in MDX format, organized by topic
+- `/src/components/` - Custom React components (AiDisclaimer, YamlEditor, SchemaViewer)
+- `/static/` - Images, schemas, and other static assets
+- `docusaurus.config.ts` - Main site configuration including redirects and integrations
+- `sidebars.ts` - Navigation structure definition
+
+### Key Integrations
+
+1. **Algolia Search** - Primary search functionality
+2. **Inkeep AI Assistant** - AI-powered help chat
+3. **Client-side redirects** - Maintains old URLs for backward compatibility
+4. **JSON Schema Plugin** - Displays configuration schemas interactively
+
+### Development Patterns
+
+1. **Adding Documentation**: Create MDX files in appropriate `/docs/` subdirectory
+2. **Custom Components**: Import from `@site/src/components/` in MDX files
+3. **Images**: Store in `/static/images/` and reference with absolute paths
+4. **Redirects**: Add to `redirects` array in `docusaurus.config.ts`
+
+### Code Style
+
+- No semicolons
+- Tabs for indentation
+- Trailing commas in multiline structures
+- Arrow functions without parentheses for single parameters
+- All formatting enforced by Prettier
+
+### Working with MDX
+
+- Supports React components within markdown
+- Use frontmatter for metadata (title, description, sidebar position)
+- Import custom components at the top of MDX files
+- Code blocks support syntax highlighting via Prism
+
+### Common Tasks
+
+**Adding a new documentation page:**
+
+1. Create MDX file in appropriate `/docs/` subdirectory
+2. Add frontmatter with title and sidebar_position
+3. Update `sidebars.ts` if creating new category
+
+**Updating configuration schemas:**
+
+1. Update schema files in `/static/schema/`
+2. Reference in docs using SchemaViewer component
+
+**Testing changes locally:**
+
+1. Run `pnpm start` to start dev server
+2. Navigate to localhost:3000
+3. Changes hot-reload automatically
+
+**Before committing:**
+
+1. Run `pnpm lint:fix` to fix formatting
+2. Run `pnpm typecheck` to ensure no TypeScript errors
+3. Run `pnpm build` to verify production build works
diff --git a/changelog-redirects.json b/changelog-redirects.json
@@ -0,0 +1,210 @@
+[
+  {
+    "from": "/docs/changelog#2025-07-23",
+    "to": "/changelog/unit-test-generation-beta"
+  },
+  {
+    "from": "/docs/changelog#2025-07-17",
+    "to": "/changelog/enhanced-reporting-capabilities"
+  },
+  {
+    "from": "/docs/changelog#2025-07-10",
+    "to": "/changelog/enhanced-python-static-analysis-nbqa-support-for-jupyter-notebooks"
+  },
+  {
+    "from": "/docs/changelog#2025-07-03",
+    "to": "/changelog/enhanced-python-static-analysis-flake8-support"
+  },
+  {
+    "from": "/docs/changelog#2025-07-01",
+    "to": "/changelog/enhanced-code-guidelines-support"
+  },
+  {
+    "from": "/docs/changelog#2025-06-27",
+    "to": "/changelog/enhanced-php-static-analysis-phpmd-and-phpcs-support"
+  },
+  {
+    "from": "/docs/changelog#2025-06-11",
+    "to": "/changelog/enhanced-static-analysis-htmlhint-and-checkmake-support"
+  },
+  {
+    "from": "/docs/changelog#2025-06-10",
+    "to": "/changelog/unit-test-generation-early-access"
+  },
+  {
+    "from": "/docs/changelog#2025-06-05",
+    "to": "/changelog/enhanced-static-analysis-dotenv-linter-and-pylint-support"
+  },
+  {
+    "from": "/docs/changelog#2025-05-25",
+    "to": "/changelog/new-security-and-code-quality-tools"
+  },
+  {
+    "from": "/docs/changelog#2025-05-19",
+    "to": "/changelog/lua-support-with-luacheck"
+  },
+  {
+    "from": "/docs/changelog#2025-05-14",
+    "to": "/changelog/coderabbit-for-vs-code-cursor-and-windsurf-is-here-"
+  },
+  {
+    "from": "/docs/changelog#2025-04-19",
+    "to": "/changelog/docstring-path-instructions"
+  },
+  {
+    "from": "/docs/changelog#2025-04-14",
+    "to": "/changelog/shopify-cli-integration-bitbucket-cloud-reporting"
+  },
+  {
+    "from": "/docs/changelog#2025-04-11",
+    "to": "/changelog/agent-chat"
+  },
+  {
+    "from": "/docs/changelog#2025-04-08",
+    "to": "/changelog/new-static-analysis-tools"
+  },
+  {
+    "from": "/docs/changelog#2025-04-01",
+    "to": "/changelog/code-graph-analysis"
+  },
+  {
+    "from": "/docs/changelog#2025-02-25",
+    "to": "/changelog/docstrings"
+  },
+  {
+    "from": "/docs/changelog#2025-02-04",
+    "to": "/changelog/bitbucket-cloud-support-circleci-pipeline-failure-detection"
+  },
+  {
+    "from": "/docs/changelog#2025-01-21",
+    "to": "/changelog/linear-issue-creation"
+  },
+  {
+    "from": "/docs/changelog#2025-01-13",
+    "to": "/changelog/gitlab-pipeline-failure-detection-and-remediation"
+  },
+  {
+    "from": "/docs/changelog#2025-01-02",
+    "to": "/changelog/github-action-failure-detection-and-remediation"
+  },
+  {
+    "from": "/docs/changelog#2024-12-23",
+    "to": "/changelog/streamlined-multi-repository-installation-for-gitlab-and-azure-devops"
+  },
+  {
+    "from": "/docs/changelog#2024-12-12",
+    "to": "/changelog/docstrings-beta"
+  },
+  {
+    "from": "/docs/changelog#2024-11-25",
+    "to": "/changelog/code-review-performance-enhancements-with-improved-comment-resolution-logic"
+  },
+  {
+    "from": "/docs/changelog#2024-11-20",
+    "to": "/changelog/support-for-on-premises-learning-and-gitlab-follow-up-issue-creation"
+  },
+  {
+    "from": "/docs/changelog#2024-11-08",
+    "to": "/changelog/eslint-support"
+  },
+  {
+    "from": "/docs/changelog#2024-10-31",
+    "to": "/changelog/learnings-and-metrics-iteration-for-coderabbit-self-hosted-customers"
+  },
+  {
+    "from": "/docs/changelog#2024-10-30",
+    "to": "/changelog/microsoft-teams-integration-bitbucket-support"
+  },
+  {
+    "from": "/docs/changelog#2024-10-22",
+    "to": "/changelog/security-and-sast-remediation-improvements"
+  },
+  {
+    "from": "/docs/changelog#2024-09-09",
+    "to": "/changelog/related-prs-and-label-suggestions"
+  },
+  {
+    "from": "/docs/changelog#2024-08-15",
+    "to": "/changelog/new-dashboard"
+  },
+  {
+    "from": "/docs/changelog#2024-07-31",
+    "to": "/changelog/grant-admin-privileges-to-members"
+  },
+  {
+    "from": "/docs/changelog#2024-07-16",
+    "to": "/changelog/new-features-and-improvements"
+  },
+  {
+    "from": "/docs/changelog#2024-05-28",
+    "to": "/changelog/new-features-and-improvements-1"
+  },
+  {
+    "from": "/docs/changelog#2024-05-23",
+    "to": "/changelog/new-features-and-improvements-2"
+  },
+  {
+    "from": "/docs/changelog#2024-04-18",
+    "to": "/changelog/static-analyzers-and-linters-integration"
+  },
+  {
+    "from": "/docs/changelog#2024-04-01",
+    "to": "/changelog/gdpr-compliance"
+  },
+  {
+    "from": "/docs/changelog#2024-03-12",
+    "to": "/changelog/github-check-fixes"
+  },
+  {
+    "from": "/docs/changelog#2024-03-11",
+    "to": "/changelog/soc-2-type-ii-compliance"
+  },
+  {
+    "from": "/docs/changelog#2024-03-02",
+    "to": "/changelog/enhanced-markdown-review"
+  },
+  {
+    "from": "/docs/changelog#2024-01-17",
+    "to": "/changelog/self-hosted-gitlab-integration"
+  },
+  {
+    "from": "/docs/changelog#2024-01-02",
+    "to": "/changelog/deep-insights-feature-release"
+  },
+  {
+    "from": "/docs/changelog#2023-12-18",
+    "to": "/changelog/request-changes-workflow"
+  },
+  {
+    "from": "/docs/changelog#2023-12-05",
+    "to": "/changelog/multiple-features-release"
+  },
+  {
+    "from": "/docs/changelog#2023-11-05",
+    "to": "/changelog/issue-validation"
+  },
+  {
+    "from": "/docs/changelog#2023-11-01",
+    "to": "/changelog/committable-suggestions"
+  },
+  {
+    "from": "/docs/changelog#2023-10-28",
+    "to": "/changelog/resolve-command"
+  },
+  {
+    "from": "/docs/changelog#2023-10-23",
+    "to": "/changelog/coderabbit-commands"
+  },
+  {
+    "from": "/docs/changelog#2023-10-12",
+    "to": "/changelog/yml-file-customization"
+  },
+  {
+    "from": "/docs/changelog#2023-09-21",
+    "to": "/changelog/path-based-review-instructions"
+  },
+  {
+    "from": "/docs/changelog#2023-09-19",
+    "to": "/changelog/introducing-coderabbit-for-gitlab-integration"
+  }
+]
diff --git a/changelog/2023-09-19-introducing-coderabbit-for-gitlab-integration.md b/changelog/2023-09-19-introducing-coderabbit-for-gitlab-integration.md
@@ -0,0 +1,14 @@
+---
+title: Introducing CodeRabbit for GitLab Integration
+date: '2023-09-19'
+slug: introducing-coderabbit-for-gitlab-integration
+tags:
+  - general
+hide_table_of_contents: true
+heroImage: /img/changelog/introducing-coderabbit-for-gitlab-integration-hero.webp
+permalink: /changelog/introducing-coderabbit-for-gitlab-integration
+---
+
+### Introducing CodeRabbit for GitLab Integration
+
+CodeRabbit is now available for GitLab! We know many of you have been waiting for this integration. Thank you for your patience. Sign up for the free trial!
diff --git a/changelog/2023-09-21-path-based-review-instructions.md b/changelog/2023-09-21-path-based-review-instructions.md
@@ -0,0 +1,36 @@
+---
+title: Path-Based Review Instructions
+date: '2023-09-21'
+slug: path-based-review-instructions
+tags:
+  - general
+hide_table_of_contents: true
+heroImage: /img/changelog/path-based-review-instructions-hero.webp
+permalink: /changelog/path-based-review-instructions
+---
+
+### Path-Based Review Instructions
+
+This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers can provide tailored review guidelines based on the file paths. These instructions are needed only if you want the reviewer to follow specific instructions besides the standard review.
+
+Adding file path prompts allows developers to specify custom instructions for different parts of the codebase. For example, you may want to enforce style guide by file types or directories.
+
+Sample Usage:
+
+```yaml
+path: **/*.js
+instructions: Review the javascript code against the google javascript style guide and point out any mismatches
+```
+
+```yaml
+path: tests/**.*
+instructions: Review the following unit test code written using the Mocha test library. Ensure that: The code adheres to best practices associated with Mocha. Descriptive test names are used to clearly convey the intent of each test.
+```
+
+> Note:
+>
+> - Paths accept glob patterns
+> - Instructions generally work well for specific additional instructions. However, they are not that effective if you are instructing AI not to do something
+> - Test the review feedback on pull requests and tailor as necessary
+
+---
diff --git a/changelog/2023-10-12-yml-file-customization.md b/changelog/2023-10-12-yml-file-customization.md
@@ -0,0 +1,16 @@
+---
+title: YML File Customization
+date: '2023-10-12'
+slug: yml-file-customization
+tags:
+  - docs
+hide_table_of_contents: true
+heroImage: /img/changelog/yml-file-customization-hero.webp
+permalink: /changelog/yml-file-customization
+---
+
+### YML File Customization
+
+CodeRabbit customizations made easy! You can now customize CodeRabbit using a YML file from your repository. To learn more, refer to our comprehensive documentation on customizing CodeRabbit.
+
+---
diff --git a/changelog/2023-10-23-coderabbit-commands.md b/changelog/2023-10-23-coderabbit-commands.md
@@ -0,0 +1,21 @@
+---
+title: CodeRabbit Commands
+date: '2023-10-23'
+slug: coderabbit-commands
+tags:
+  - general
+hide_table_of_contents: true
+heroImage: /img/changelog/coderabbit-commands-hero.webp
+permalink: /changelog/coderabbit-commands
+---
+
+### CodeRabbit Commands
+
+Introducing additional CodeRabbit commands for managing code reviews:
+
+- Pause Reviews: Use `@coderabbitai pause` in a PR comment to halt ongoing reviews
+- Resume Reviews: Enter `@coderabbitai resume` in a PR comment to continue paused reviews
+- On-Demand Reviews: Disable automatic reviews for your repository to switch to on-demand reviews. Use `@coderabbitai review` in a PR comment. This command will override all review filters that might be set up in the repository settings and will initiate a one-time review
+- Help Command: You can at any time post `@coderabbitai help` in a PR comment to get the list of all valid commands
+
+---