Skip to content

Commit cd9f15e

Browse files
edgarcerecerezedgarcerecerez
committed
changelog wip
1 parent a9bb694 commit cd9f15e

File tree

100 files changed

+16356
-8151
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+16356
-8151
lines changed

‎CLAUDE.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Project Overview
6+
7+
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.
8+
9+
## Essential Commands
10+
11+
```bash
12+
# Development (MUST use pnpm)
13+
pnpm install # Install dependencies
14+
pnpm start # Start dev server at localhost:3000
15+
pnpm build # Build for production
16+
pnpm serve # Serve production build locally
17+
18+
# Code Quality
19+
pnpm lint # Check markdown and formatting
20+
pnpm lint:fix # Auto-fix issues
21+
pnpm format # Format all files
22+
pnpm typecheck # TypeScript type checking
23+
24+
# Cleanup
25+
pnpm clean # Remove build artifacts and node_modules
26+
pnpm clear # Clear Docusaurus cache
27+
```
28+
29+
## Architecture & Key Concepts
30+
31+
### Documentation Structure
32+
33+
- `/docs/` - All documentation content in MDX format, organized by topic
34+
- `/src/components/` - Custom React components (AiDisclaimer, YamlEditor, SchemaViewer)
35+
- `/static/` - Images, schemas, and other static assets
36+
- `docusaurus.config.ts` - Main site configuration including redirects and integrations
37+
- `sidebars.ts` - Navigation structure definition
38+
39+
### Key Integrations
40+
41+
1. **Algolia Search** - Primary search functionality
42+
2. **Inkeep AI Assistant** - AI-powered help chat
43+
3. **Client-side redirects** - Maintains old URLs for backward compatibility
44+
4. **JSON Schema Plugin** - Displays configuration schemas interactively
45+
46+
### Development Patterns
47+
48+
1. **Adding Documentation**: Create MDX files in appropriate `/docs/` subdirectory
49+
2. **Custom Components**: Import from `@site/src/components/` in MDX files
50+
3. **Images**: Store in `/static/images/` and reference with absolute paths
51+
4. **Redirects**: Add to `redirects` array in `docusaurus.config.ts`
52+
53+
### Code Style
54+
55+
- No semicolons
56+
- Tabs for indentation
57+
- Trailing commas in multiline structures
58+
- Arrow functions without parentheses for single parameters
59+
- All formatting enforced by Prettier
60+
61+
### Working with MDX
62+
63+
- Supports React components within markdown
64+
- Use frontmatter for metadata (title, description, sidebar position)
65+
- Import custom components at the top of MDX files
66+
- Code blocks support syntax highlighting via Prism
67+
68+
### Common Tasks
69+
70+
**Adding a new documentation page:**
71+
72+
1. Create MDX file in appropriate `/docs/` subdirectory
73+
2. Add frontmatter with title and sidebar_position
74+
3. Update `sidebars.ts` if creating new category
75+
76+
**Updating configuration schemas:**
77+
78+
1. Update schema files in `/static/schema/`
79+
2. Reference in docs using SchemaViewer component
80+
81+
**Testing changes locally:**
82+
83+
1. Run `pnpm start` to start dev server
84+
2. Navigate to localhost:3000
85+
3. Changes hot-reload automatically
86+
87+
**Before committing:**
88+
89+
1. Run `pnpm lint:fix` to fix formatting
90+
2. Run `pnpm typecheck` to ensure no TypeScript errors
91+
3. Run `pnpm build` to verify production build works

‎changelog-redirects.json

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
[
2+
{
3+
"from": "/docs/changelog#2025-07-23",
4+
"to": "/changelog/unit-test-generation-beta"
5+
},
6+
{
7+
"from": "/docs/changelog#2025-07-17",
8+
"to": "/changelog/enhanced-reporting-capabilities"
9+
},
10+
{
11+
"from": "/docs/changelog#2025-07-10",
12+
"to": "/changelog/enhanced-python-static-analysis-nbqa-support-for-jupyter-notebooks"
13+
},
14+
{
15+
"from": "/docs/changelog#2025-07-03",
16+
"to": "/changelog/enhanced-python-static-analysis-flake8-support"
17+
},
18+
{
19+
"from": "/docs/changelog#2025-07-01",
20+
"to": "/changelog/enhanced-code-guidelines-support"
21+
},
22+
{
23+
"from": "/docs/changelog#2025-06-27",
24+
"to": "/changelog/enhanced-php-static-analysis-phpmd-and-phpcs-support"
25+
},
26+
{
27+
"from": "/docs/changelog#2025-06-11",
28+
"to": "/changelog/enhanced-static-analysis-htmlhint-and-checkmake-support"
29+
},
30+
{
31+
"from": "/docs/changelog#2025-06-10",
32+
"to": "/changelog/unit-test-generation-early-access"
33+
},
34+
{
35+
"from": "/docs/changelog#2025-06-05",
36+
"to": "/changelog/enhanced-static-analysis-dotenv-linter-and-pylint-support"
37+
},
38+
{
39+
"from": "/docs/changelog#2025-05-25",
40+
"to": "/changelog/new-security-and-code-quality-tools"
41+
},
42+
{
43+
"from": "/docs/changelog#2025-05-19",
44+
"to": "/changelog/lua-support-with-luacheck"
45+
},
46+
{
47+
"from": "/docs/changelog#2025-05-14",
48+
"to": "/changelog/coderabbit-for-vs-code-cursor-and-windsurf-is-here-"
49+
},
50+
{
51+
"from": "/docs/changelog#2025-04-19",
52+
"to": "/changelog/docstring-path-instructions"
53+
},
54+
{
55+
"from": "/docs/changelog#2025-04-14",
56+
"to": "/changelog/shopify-cli-integration-bitbucket-cloud-reporting"
57+
},
58+
{
59+
"from": "/docs/changelog#2025-04-11",
60+
"to": "/changelog/agent-chat"
61+
},
62+
{
63+
"from": "/docs/changelog#2025-04-08",
64+
"to": "/changelog/new-static-analysis-tools"
65+
},
66+
{
67+
"from": "/docs/changelog#2025-04-01",
68+
"to": "/changelog/code-graph-analysis"
69+
},
70+
{
71+
"from": "/docs/changelog#2025-02-25",
72+
"to": "/changelog/docstrings"
73+
},
74+
{
75+
"from": "/docs/changelog#2025-02-04",
76+
"to": "/changelog/bitbucket-cloud-support-circleci-pipeline-failure-detection"
77+
},
78+
{
79+
"from": "/docs/changelog#2025-01-21",
80+
"to": "/changelog/linear-issue-creation"
81+
},
82+
{
83+
"from": "/docs/changelog#2025-01-13",
84+
"to": "/changelog/gitlab-pipeline-failure-detection-and-remediation"
85+
},
86+
{
87+
"from": "/docs/changelog#2025-01-02",
88+
"to": "/changelog/github-action-failure-detection-and-remediation"
89+
},
90+
{
91+
"from": "/docs/changelog#2024-12-23",
92+
"to": "/changelog/streamlined-multi-repository-installation-for-gitlab-and-azure-devops"
93+
},
94+
{
95+
"from": "/docs/changelog#2024-12-12",
96+
"to": "/changelog/docstrings-beta"
97+
},
98+
{
99+
"from": "/docs/changelog#2024-11-25",
100+
"to": "/changelog/code-review-performance-enhancements-with-improved-comment-resolution-logic"
101+
},
102+
{
103+
"from": "/docs/changelog#2024-11-20",
104+
"to": "/changelog/support-for-on-premises-learning-and-gitlab-follow-up-issue-creation"
105+
},
106+
{
107+
"from": "/docs/changelog#2024-11-08",
108+
"to": "/changelog/eslint-support"
109+
},
110+
{
111+
"from": "/docs/changelog#2024-10-31",
112+
"to": "/changelog/learnings-and-metrics-iteration-for-coderabbit-self-hosted-customers"
113+
},
114+
{
115+
"from": "/docs/changelog#2024-10-30",
116+
"to": "/changelog/microsoft-teams-integration-bitbucket-support"
117+
},
118+
{
119+
"from": "/docs/changelog#2024-10-22",
120+
"to": "/changelog/security-and-sast-remediation-improvements"
121+
},
122+
{
123+
"from": "/docs/changelog#2024-09-09",
124+
"to": "/changelog/related-prs-and-label-suggestions"
125+
},
126+
{
127+
"from": "/docs/changelog#2024-08-15",
128+
"to": "/changelog/new-dashboard"
129+
},
130+
{
131+
"from": "/docs/changelog#2024-07-31",
132+
"to": "/changelog/grant-admin-privileges-to-members"
133+
},
134+
{
135+
"from": "/docs/changelog#2024-07-16",
136+
"to": "/changelog/new-features-and-improvements"
137+
},
138+
{
139+
"from": "/docs/changelog#2024-05-28",
140+
"to": "/changelog/new-features-and-improvements-1"
141+
},
142+
{
143+
"from": "/docs/changelog#2024-05-23",
144+
"to": "/changelog/new-features-and-improvements-2"
145+
},
146+
{
147+
"from": "/docs/changelog#2024-04-18",
148+
"to": "/changelog/static-analyzers-and-linters-integration"
149+
},
150+
{
151+
"from": "/docs/changelog#2024-04-01",
152+
"to": "/changelog/gdpr-compliance"
153+
},
154+
{
155+
"from": "/docs/changelog#2024-03-12",
156+
"to": "/changelog/github-check-fixes"
157+
},
158+
{
159+
"from": "/docs/changelog#2024-03-11",
160+
"to": "/changelog/soc-2-type-ii-compliance"
161+
},
162+
{
163+
"from": "/docs/changelog#2024-03-02",
164+
"to": "/changelog/enhanced-markdown-review"
165+
},
166+
{
167+
"from": "/docs/changelog#2024-01-17",
168+
"to": "/changelog/self-hosted-gitlab-integration"
169+
},
170+
{
171+
"from": "/docs/changelog#2024-01-02",
172+
"to": "/changelog/deep-insights-feature-release"
173+
},
174+
{
175+
"from": "/docs/changelog#2023-12-18",
176+
"to": "/changelog/request-changes-workflow"
177+
},
178+
{
179+
"from": "/docs/changelog#2023-12-05",
180+
"to": "/changelog/multiple-features-release"
181+
},
182+
{
183+
"from": "/docs/changelog#2023-11-05",
184+
"to": "/changelog/issue-validation"
185+
},
186+
{
187+
"from": "/docs/changelog#2023-11-01",
188+
"to": "/changelog/committable-suggestions"
189+
},
190+
{
191+
"from": "/docs/changelog#2023-10-28",
192+
"to": "/changelog/resolve-command"
193+
},
194+
{
195+
"from": "/docs/changelog#2023-10-23",
196+
"to": "/changelog/coderabbit-commands"
197+
},
198+
{
199+
"from": "/docs/changelog#2023-10-12",
200+
"to": "/changelog/yml-file-customization"
201+
},
202+
{
203+
"from": "/docs/changelog#2023-09-21",
204+
"to": "/changelog/path-based-review-instructions"
205+
},
206+
{
207+
"from": "/docs/changelog#2023-09-19",
208+
"to": "/changelog/introducing-coderabbit-for-gitlab-integration"
209+
}
210+
]

‎changelog/2023-09-19-introducing-coderabbit-for-gitlab-integration.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Introducing CodeRabbit for GitLab Integration
3+
date: '2023-09-19'
4+
slug: introducing-coderabbit-for-gitlab-integration
5+
tags:
6+
- general
7+
hide_table_of_contents: true
8+
heroImage: /img/changelog/introducing-coderabbit-for-gitlab-integration-hero.webp
9+
permalink: /changelog/introducing-coderabbit-for-gitlab-integration
10+
---
11+
12+
### Introducing CodeRabbit for GitLab Integration
13+
14+
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!

‎changelog/2023-09-21-path-based-review-instructions.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Path-Based Review Instructions
3+
date: '2023-09-21'
4+
slug: path-based-review-instructions
5+
tags:
6+
- general
7+
hide_table_of_contents: true
8+
heroImage: /img/changelog/path-based-review-instructions-hero.webp
9+
permalink: /changelog/path-based-review-instructions
10+
---
11+
12+
### Path-Based Review Instructions
13+
14+
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.
15+
16+
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.
17+
18+
Sample Usage:
19+
20+
```yaml
21+
path: **/*.js
22+
instructions: Review the javascript code against the google javascript style guide and point out any mismatches
23+
```
24+
25+
```yaml
26+
path: tests/**.*
27+
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.
28+
```
29+
30+
> Note:
31+
>
32+
> - Paths accept glob patterns
33+
> - Instructions generally work well for specific additional instructions. However, they are not that effective if you are instructing AI not to do something
34+
> - Test the review feedback on pull requests and tailor as necessary
35+
36+
---

‎changelog/2023-10-12-yml-file-customization.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: YML File Customization
3+
date: '2023-10-12'
4+
slug: yml-file-customization
5+
tags:
6+
- docs
7+
hide_table_of_contents: true
8+
heroImage: /img/changelog/yml-file-customization-hero.webp
9+
permalink: /changelog/yml-file-customization
10+
---
11+
12+
### YML File Customization
13+
14+
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.
15+
16+
---

‎changelog/2023-10-23-coderabbit-commands.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: CodeRabbit Commands
3+
date: '2023-10-23'
4+
slug: coderabbit-commands
5+
tags:
6+
- general
7+
hide_table_of_contents: true
8+
heroImage: /img/changelog/coderabbit-commands-hero.webp
9+
permalink: /changelog/coderabbit-commands
10+
---
11+
12+
### CodeRabbit Commands
13+
14+
Introducing additional CodeRabbit commands for managing code reviews:
15+
16+
- Pause Reviews: Use `@coderabbitai pause` in a PR comment to halt ongoing reviews
17+
- Resume Reviews: Enter `@coderabbitai resume` in a PR comment to continue paused reviews
18+
- 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
19+
- Help Command: You can at any time post `@coderabbitai help` in a PR comment to get the list of all valid commands
20+
21+
---

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy