Jul 31, 2025 · Jul 30, 2025 · Jul 31, 2025
diff --git a/docs/changelog.md b/docs/changelog.md

 New and Improved Dashboards to provide more useful feedback such as:

 -Avgerage PR Merge Time
 -Average PR Merge Time
 - Weekly Pull Request Activity
 - Number of PRs Reviewed
 - Acceptance rate of CodeRabbit Suggestions
diff --git a/docs/faq.md b/docs/faq.md
 - Available training data
 - Community usage patterns

 ###Whats the difference between CodeRabbit Code Reviews and CodeRabbit Reports?
 ###What's the difference between CodeRabbit Code Reviews and CodeRabbit Reports?

 CodeRabbit offers two distinct features that serve different roles in your development workflow:

diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md
 ####Summarized PR Details

 -`<pr_description>`: string - Contains the body of your pull request (aka the PR description at the top of the PR page).
 -`<file_changes_summary>`: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AIdurring the PR review process. This includes several sections for each file that was changed:
 -`<file_changes_summary>`: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AIduring the PR review process. This includes several sections for each file that was changed:
 -`filename`: string - The name of the file that was changed.
 -`AI-generated summary of changes`: markdown - An overall summary of the changes made in the file.
 -`Alterations to the declarations of exported or public entities`: markdown - A more specific breakdown of the changes made to the file such as exactly what was added, removed, or modified.

 This option gives you the ability to create a report limited only to pull requests containing a "Score Card" or "Score Chart" bot comment from CodeRabbit or other bots. To enable issues and tickets you must include the tag`<pr_score_card>` in your prompt.

 >**IMPORTANT:** This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in`No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have asked coderabbit to create a "Score Card" thourhg a comment orimplimented the "Score Chart" bot comment flow below.
 >**IMPORTANT:** This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in`No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have asked coderabbit to create a "Score Card" thourhg a comment orimplemented the "Score Chart" bot comment flow below.

 For example you can ask coderabbit to checkserveral conditions on a pull request and produce a "Score Chart":
 For example you can ask coderabbit to checkseveral conditions on a pull request and produce a "Score Chart":

 <details>
 <summary>Click to view example User Score Card/Chart Comment:</summary>
diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md

 This page is about using the CodeRabbit API to generate on-demand reports about your organization's usage of CodeRabbit. For a conceptual overview of reports in CodeRabbit, see[Generate reports](/guides/reports-overview).

 If you're new to CodeRabbit's reporting features, then we recommend starting with[Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities. In almost every scenario we recommend using the**Scheduled Reports** option. The**On-demand Report** does not have any additionalbenifits from the**Scheduled Reports** and has many limitations.
 If you're new to CodeRabbit's reporting features, then we recommend starting with[Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities. In almost every scenario we recommend using the**Scheduled Reports** option. The**On-demand Report** does not have any additionalbenefits from the**Scheduled Reports** and has many limitations.

 ##API Access

diff --git a/docs/guides/reports-overview.md b/docs/guides/reports-overview.md

 -**[On-demand Reports](/guides/ondemand-reports)**: If you want to test a report format and produce a single report once, try the "On-demand Reports" Option. You can also generate reports programmatically through our API, but we do not recommend this as the API reporting is in beta. If you want to run an**On-demand Report** more than once then you must use the**Scheduled Reports** option.

 In almost every scenario we recommend using the**Scheduled Reports** option. The**On-demand Report** does not have any additionalbenifits from the**Scheduled Reports** and has many limitations.
 In almost every scenario we recommend using the**Scheduled Reports** option. The**On-demand Report** does not have any additionalbenefits from the**Scheduled Reports** and has many limitations.

 ##Customize reports using natural language {#customize}

diff --git a/docs/guides/setup-best-practices.md b/docs/guides/setup-best-practices.md
 ---
 title:"Setup and configuration best practices"
 description:Best practices forseting up CodeRabbit.
 description:Best practices forsetting up CodeRabbit.
 sidebar_label:Setup and configuration
 ---

diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
 Activate this setting to disallow CodeRabbit from caching your repository's code and dependencies. This forces CodeRabbit to download the code and dependencies fresh from the repository for every code review that it performs.

 When caching is allowed, then CodeRabbit stores a cache of code and metadata from
 yourrepostory for up to seven days after its most recent code review. This cache
 lets CodeRabbit save time and effort in betweensubsquent reviews of the same
 yourrepository for up to seven days after its most recent code review. This cache
 lets CodeRabbit save time and effort in betweensubsequent reviews of the same
 repository. For more information, see[Caching](/reference/caching/).

 We recommend leaving this setting off, which allows caching, and can speed up
  </TabItem>
 </Tabs>

 Path instructions are additional sets of instructions, expressed in naturallanaguge,
 that you provide to CodeRabbit forreveiwing certain files in your repository.
 Path instructions are additional sets of instructions, expressed in naturallanguage,
 that you provide to CodeRabbit forreviewing certain files in your repository.

 You associate each set ofinstuctions with a file path relative to the root
 You associate each set ofinstructions with a file path relative to the root
 of your repository. Your path specification can use extended glob patterns.

 The following example defines a set of path instructions for all TypeScript
  </TabItem>
 </Tabs>

 For further examples of path instructions specific to various programminglangauges,
 For further examples of path instructions specific to various programminglanguages,
 see [the`awesome-coderabbit` public repository](https://github.com/coderabbitai/awesome-coderabbit/tree/main/configs).

 #### Poem
diff --git a/tailwind.config.js b/tailwind.config.js
 preflight:false,// disable Tailwind's reset
 },
 content:["./src/**/*.{js,jsx,ts,tsx}","../docs/**/*.mdx"],// my markdown stuff is in ../docs, not /src
 darkMode:["class",'[data-theme="dark"]'],// hooks into docusaurus' dark modesettigns
 darkMode:["class",'[data-theme="dark"]'],// hooks into docusaurus' dark modesettings
 theme:{
 fontFamily:{
 figtree:["Figtree","sans-serif"],
Original file line number	Diff line number	Diff line change
Expand Up		@@ -250,7 +250,7 @@ import ProPlanNotice from "@site/src/components/ProPlanNotice.mdx"

		New and Improved Dashboards to provide more useful feedback such as:

		-Avgerage PR Merge Time
		-Average PR Merge Time
		- Weekly Pull Request Activity
		- Number of PRs Reviewed
		- Acceptance rate of CodeRabbit Suggestions
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -63,7 +63,7 @@ CodeRabbit works with all programming languages, with varying proficiency based
		- Available training data
		- Community usage patterns

		###Whats the difference between CodeRabbit Code Reviews and CodeRabbit Reports?
		###What's the difference between CodeRabbit Code Reviews and CodeRabbit Reports?

		CodeRabbit offers two distinct features that serve different roles in your development workflow:

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -103,7 +103,7 @@ Contained within the `<pr_details>` tag.
		####Summarized PR Details

		-`<pr_description>`: string - Contains the body of your pull request (aka the PR description at the top of the PR page).
		-`<file_changes_summary>`: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AIdurring the PR review process. This includes several sections for each file that was changed:
		-`<file_changes_summary>`: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AIduring the PR review process. This includes several sections for each file that was changed:
		-`filename`: string - The name of the file that was changed.
		-`AI-generated summary of changes`: markdown - An overall summary of the changes made in the file.
		-`Alterations to the declarations of exported or public entities`: markdown - A more specific breakdown of the changes made to the file such as exactly what was added, removed, or modified.
Expand DownExpand Up		@@ -307,9 +307,9 @@ Issues and tickets brings in conversations, descriptions, and comments from Jira

		This option gives you the ability to create a report limited only to pull requests containing a "Score Card" or "Score Chart" bot comment from CodeRabbit or other bots. To enable issues and tickets you must include the tag`<pr_score_card>` in your prompt.

		>IMPORTANT: This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in`No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have asked coderabbit to create a "Score Card" thourhg a comment orimplimented the "Score Chart" bot comment flow below.
		>IMPORTANT: This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in`No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have asked coderabbit to create a "Score Card" thourhg a comment orimplemented the "Score Chart" bot comment flow below.

		For example you can ask coderabbit to checkserveral conditions on a pull request and produce a "Score Chart":
		For example you can ask coderabbit to checkseveral conditions on a pull request and produce a "Score Chart":

		<details>
		<summary>Click to view example User Score Card/Chart Comment:</summary>
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,7 +14,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

		This page is about using the CodeRabbit API to generate on-demand reports about your organization's usage of CodeRabbit. For a conceptual overview of reports in CodeRabbit, see[Generate reports](/guides/reports-overview).

		If you're new to CodeRabbit's reporting features, then we recommend starting with[Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities. In almost every scenario we recommend using theScheduled Reports option. TheOn-demand Report does not have any additionalbenifits from theScheduled Reports and has many limitations.
		If you're new to CodeRabbit's reporting features, then we recommend starting with[Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities. In almost every scenario we recommend using theScheduled Reports option. TheOn-demand Report does not have any additionalbenefits from theScheduled Reports and has many limitations.

		##API Access

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,7 +26,7 @@ There are two ways to generate reports:

		-[On-demand Reports](/guides/ondemand-reports): If you want to test a report format and produce a single report once, try the "On-demand Reports" Option. You can also generate reports programmatically through our API, but we do not recommend this as the API reporting is in beta. If you want to run anOn-demand Report more than once then you must use theScheduled Reports option.

		In almost every scenario we recommend using theScheduled Reports option. TheOn-demand Report does not have any additionalbenifits from theScheduled Reports and has many limitations.
		In almost every scenario we recommend using theScheduled Reports option. TheOn-demand Report does not have any additionalbenefits from theScheduled Reports and has many limitations.

		##Customize reports using natural language {#customize}

Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,6 +1,6 @@
		---
		title:"Setup and configuration best practices"
		description:Best practices forseting up CodeRabbit.
		description:Best practices forsetting up CodeRabbit.
		sidebar_label:Setup and configuration
		---

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -604,8 +604,8 @@ Set the commit status to 'pending' when the review is in progress and 'success'
		Activate this setting to disallow CodeRabbit from caching your repository's code and dependencies. This forces CodeRabbit to download the code and dependencies fresh from the repository for every code review that it performs.

		When caching is allowed, then CodeRabbit stores a cache of code and metadata from
		yourrepostory for up to seven days after its most recent code review. This cache
		lets CodeRabbit save time and effort in betweensubsquent reviews of the same
		yourrepository for up to seven days after its most recent code review. This cache
		lets CodeRabbit save time and effort in betweensubsequent reviews of the same
		repository. For more information, see[Caching](/reference/caching/).

		We recommend leaving this setting off, which allows caching, and can speed up
Expand DownExpand Up		@@ -902,10 +902,10 @@ For more information, see [Speed up reviews by adding path filters](https://docs
		</TabItem>
		</Tabs>

		Path instructions are additional sets of instructions, expressed in naturallanaguge,
		that you provide to CodeRabbit forreveiwing certain files in your repository.
		Path instructions are additional sets of instructions, expressed in naturallanguage,
		that you provide to CodeRabbit forreviewing certain files in your repository.

		You associate each set ofinstuctions with a file path relative to the root
		You associate each set ofinstructions with a file path relative to the root
		of your repository. Your path specification can use extended glob patterns.

		The following example defines a set of path instructions for all TypeScript
Expand All		@@ -929,7 +929,7 @@ path_instructions:
		</TabItem>
		</Tabs>

		For further examples of path instructions specific to various programminglangauges,
		For further examples of path instructions specific to various programminglanguages,
		see [the`awesome-coderabbit` public repository](https://github.com/coderabbitai/awesome-coderabbit/tree/main/configs).

		#### Poem
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -21,7 +21,7 @@ module.exports = {
		preflight:false,// disable Tailwind's reset
		},
		content:["./src/*/.{js,jsx,ts,tsx}","../docs/*/.mdx"],// my markdown stuff is in ../docs, not /src
		darkMode:["class",'[data-theme="dark"]'],// hooks into docusaurus' dark modesettigns
		darkMode:["class",'[data-theme="dark"]'],// hooks into docusaurus' dark modesettings
		theme:{
		fontFamily:{
		figtree:["Figtree","sans-serif"],
Expand Down