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

- Available training data

- Community usage patterns

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

-`<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.

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>

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.

-**[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.

title:"Setup and configuration best practices"

description:Best practices forseting up CodeRabbit.

description:Best practices forsetting up CodeRabbit.

sidebar_label:Setup and configuration

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

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"],