From 773f43c1306a548f91394b03e4da97e2c8c01872 Mon Sep 17 00:00:00 2001 From: Kian-Meng Ang Date: Wed, 30 Jul 2025 14:33:08 +0800 Subject: [PATCH] Fix typos Found via `codespell -S pnpm-lock.yaml -L ned,sav,paket` --- docs/changelog.md | 2 +- docs/faq.md | 2 +- docs/guides/custom-reports.md | 6 +++--- docs/guides/ondemand-reports.md | 2 +- docs/guides/reports-overview.md | 2 +- docs/guides/setup-best-practices.md | 2 +- docs/reference/configuration.md | 12 ++++++------ tailwind.config.js | 2 +- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index ec081fb5..2570a905 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -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 diff --git a/docs/faq.md b/docs/faq.md index 795ce900..f248b517 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -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: diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index b2a10504..6fcc1e77 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -103,7 +103,7 @@ Contained within the `` tag. #### Summarized PR Details - ``: string - Contains the body of your pull request (aka the PR description at the top of the PR page). -- ``: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AI durring the PR review process. This includes several sections for each file that was changed: +- ``: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AI during 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. @@ -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 `` 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 or implimented 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 or implemented the "Score Chart" bot comment flow below. -For example you can ask coderabbit to check serveral conditions on a pull request and produce a "Score Chart": +For example you can ask coderabbit to check several conditions on a pull request and produce a "Score Chart":
Click to view example User Score Card/Chart Comment: diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md index af380164..49214e32 100644 --- a/docs/guides/ondemand-reports.md +++ b/docs/guides/ondemand-reports.md @@ -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 the **Scheduled Reports** option. The **On-demand Report** does not have any additional benifits 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 additional benefits from the **Scheduled Reports** and has many limitations. ## API Access diff --git a/docs/guides/reports-overview.md b/docs/guides/reports-overview.md index b15329f0..5095364f 100644 --- a/docs/guides/reports-overview.md +++ b/docs/guides/reports-overview.md @@ -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 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 additional benifits 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 additional benefits 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 index c6caa094..0533da5e 100644 --- a/docs/guides/setup-best-practices.md +++ b/docs/guides/setup-best-practices.md @@ -1,6 +1,6 @@ --- title: "Setup and configuration best practices" -description: Best practices for seting up CodeRabbit. +description: Best practices for setting up CodeRabbit. sidebar_label: Setup and configuration --- diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 5b59933f..00e71f6d 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -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 -your repostory for up to seven days after its most recent code review. This cache -lets CodeRabbit save time and effort in between subsquent reviews of the same +your repository for up to seven days after its most recent code review. This cache +lets CodeRabbit save time and effort in between subsequent 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 @@ -902,10 +902,10 @@ For more information, see [Speed up reviews by adding path filters](https://docs -Path instructions are additional sets of instructions, expressed in natural lanaguge, -that you provide to CodeRabbit for reveiwing certain files in your repository. +Path instructions are additional sets of instructions, expressed in natural language, +that you provide to CodeRabbit for reviewing certain files in your repository. -You associate each set of instuctions with a file path relative to the root +You associate each set of instructions 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 @@ -929,7 +929,7 @@ path_instructions: -For further examples of path instructions specific to various programming langauges, +For further examples of path instructions specific to various programming languages, 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 index b24582d0..dd081f63 100644 --- a/tailwind.config.js +++ b/tailwind.config.js @@ -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 mode settigns + darkMode: ["class", '[data-theme="dark"]'], // hooks into docusaurus' dark mode settings theme: { fontFamily: { figtree: ["Figtree", "sans-serif"],