Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Add new configuration guides and reference material.#405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
jmacdotorg merged 19 commits intomainfromconfig
Jun 25, 2025
Merged

Conversation

jmacdotorg
Copy link
Contributor

@jmacdotorgjmacdotorg commentedJun 19, 2025
edited
Loading

This adds a bunch of pages, all about configuration.

On staging:

A few notes:

  • The initial-config guide is the centerpiece here in some ways, responding to a desire to have a little more guidance about navigating CodeRabbit's sea of config options
  • The new reference page was generated from our schema file. Several of the descriptions are expanded and rewritten (especially if the new initial-config guide links to them), and several are just copied over verbatim for now. We should rewrite and expand all of these in future iterations of this page.
  • This work doesn't update the docs about CodeRabbit.yaml at all. Fast-follow work includes tidying up that page and adding more reference material just about that file.

Fixes#304,fixes#374,fixes#375,fixes#377

@jmacdotorgjmacdotorg requested a review froma team as acode ownerJune 19, 2025 18:28
@coderabbitaicoderabbitai
Copy link
Contributor

coderabbitaibot commentedJun 19, 2025
edited
Loading

"""

Walkthrough

Several new documentation guides were added to provide comprehensive coverage of CodeRabbit configuration at the organization and repository levels, including an initial configuration guide and detailed instructions for setting preferences. A new YAML configuration template file was introduced. The documentation sidebar was updated to include these new guides and reference entries. The repository configuration filename was standardized to.coderabbit.yaml in the best practices guide. No changes were made to code or exported entities.

Changes

File(s)Change Summary
docs/guides/configuration-overview.md,
docs/guides/initial-configuration.md,
docs/guides/organization-settings.md,
docs/guides/repository-settings.md,
docs/guides/setup-best-practices.md
Added new documentation guides detailing configuration options and setup at organization and repository levels; standardized config filename to.coderabbit.yaml in best practices.
docs/getting-started/configure-coderabbit.mdUpdated to reference a complete sample.coderabbit.yaml template file instead of an inline sample snippet.
docs/reference/yaml-template.mdAdded a comprehensive YAML configuration template for.coderabbit.yaml detailing all repository config options.
sidebars.tsUpdated sidebar to include new configuration guides and reference entries for configuration and YAML template.

Assessment against linked issues

ObjectiveAddressedExplanation
Add a configuration overview page (#304)
Add a configuration reference covering all configurable aspects with UI and YAML locations (#374)
Add an exhaustive YAML file listing all configurable options with defaults (#375)
Revise code review best practice pages to include configuration recommendations (#377)

Poem

In the warren of docs, new guides now appear,
For teams and for orgs, the setup is clear.
The sidebar’s refreshed, with knowledge in tow,
Configuration paths, now easy to know.
A rabbit’s delight—let’s hop in and read,
For CodeRabbit’s wisdom is all that you need!
🐇📚✨
"""

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branchconfig

🪧 Tips

Chat

There are 3 ways to chat withCodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag@coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag@coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on oursupport page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings togenerate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add@coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add@coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add@coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a.coderabbit.yaml file to the root of your repository.
  • Please see theconfiguration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit ourDocumentation for detailed information on how to use CodeRabbit.
  • Join ourDiscord Community to get help, request features, and share feedback.
  • Follow us onX/Twitter for updates and announcements.

@jmacdotorgjmacdotorg marked this pull request as draftJune 19, 2025 18:28
@cloudflare-workers-and-pagesCloudflare Workers and Pages
Copy link

cloudflare-workers-and-pagesbot commentedJun 19, 2025
edited
Loading

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit:fe81cb3
Status: ✅  Deploy successful!
Preview URL:https://ba64ef65.coderabbit-docs.pages.dev
Branch Preview URL:https://config.coderabbit-docs.pages.dev

View logs

Copy link
Contributor

@coderabbitaicoderabbitaibot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (19)
docs/guides/organization-settings.md (2)

2-2:Fix typo in title frontmatter
The word “orgnaization” is misspelled.
Apply this diff:

-title: Set your orgnaization preferences+title: Set your organization preferences

24-26:Use sequential list numbering
All steps are marked “1.” which works but can be confusing. Consider numbering them1.,2.,3. for clarity.

docs/guides/repository-settings.md (1)

13-14:Fix spelling in step description
The word “repostory” is misspelled. Also, consider using1. and2. for list items.

-1. Add a `coderabbit.yaml` file to your repostory.+2. Add a `coderabbit.yaml` file to your repository.
docs/guides/configuration-overview.md (3)

20-21:Fix typo in “inlcude”
Change “inlcude” to “include”:


24-24:Fix spelling of “organiation’s”
Correct to “organization’s”:


34-34:Add missing space in “CodeRabbitweb”
Insert a space between “CodeRabbit” and “web”:

docs/guides/initial-configuration.md (13)

8-8:Fix typo in “conifguration”
Correct the spelling of “conifguration”:


15-15:Remove duplicated “Tthe”
Change “Tthe” to “The”:


47-47:Fix typo in “integreated”
Correct to “integrated”:


53-53:Remove duplicate word and fix spellings
Eliminate repeated “these” and correct “prefrences”/“reveiws”:


60-60:Improve phrasing and fix typos
Replace “deliver perform faster” and “opt of” with correct wording:


71-71:Fix typo in “repositries”
Correct to “repositories”:


73-73:Add missing article for clarity
Insert “a” before “strict data retention policy”:


80-80:Correct spelling of “defualt” and “subsquent”


87-87:Apply same cache typo fixes in second instance


108-108:Remove duplicated “and”


119-119:Consider more concise phrasing
Remove “of” for brevity:


123-123:Specify fenced code block language
Add a language tag for syntax highlighting, e.g.,yaml orjson:

-````+```yaml

127-131:Replace hard tabs with spaces
Convert indentation inside the fenced block to spaces to avoid hard tabs.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between228e9f5 and2617e73.

⛔ Files ignored due to path filters (1)
  • static/img/reference/path-instructions.png is excluded by!**/*.png,!**/*.png
📒 Files selected for processing (5)
  • docs/guides/configuration-overview.md (1 hunks)
  • docs/guides/initial-configuration.md (1 hunks)
  • docs/guides/organization-settings.md (1 hunks)
  • docs/guides/repository-settings.md (1 hunks)
  • sidebars.ts (2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/initial-configuration.md

[style] ~13-~13: Consider a more concise word here.
Context: ... configuration options that you can set in order to tune CodeRabbit code review behavior fo...

(IN_ORDER_TO_PREMIUM)


[duplication] ~53-~53: Possible typo: you repeated a word.
Context: ...e-base#learnings). CodeRabbit remembers these these prefrences, and applies them to subsequ...

(ENGLISH_WORD_REPEAT_RULE)


[style] ~60-~60: Consider a more concise word here.
Context: ...res information about your repositories in order to deliver perform faster and more tailore...

(IN_ORDER_TO_PREMIUM)


[uncategorized] ~60-~60: “of” seems less likely than “off” (as in: go/turn off, off the coast).
Context: ... more tailored reviews, but you can opt of these features if your organization has...

(AI_HYDRA_LEO_CP_OF_OFF)


[uncategorized] ~73-~73: Possible missing article found.
Context: ...ver, if your use of CodeRabbit requires strict data retention policy, then you can tur...

(AI_HYDRA_LEO_MISSING_A)


[style] ~80-~80: Consider a more concise word here.
Context: ...ary cache of data about your repository in order to make subsquent code reviews faster. If ...

(IN_ORDER_TO_PREMIUM)


[style] ~80-~80: Consider using a different verb to strengthen your wording.
Context: ... data about your repository in order to make subsquent code reviews faster. If this conflicts with your organizati...

(MAKE_XXX_FASTER)


[style] ~87-~87: Consider a more concise word here.
Context: ...ary cache of data about your repository in order to make subsquent code reviews faster. If ...

(IN_ORDER_TO_PREMIUM)


[style] ~87-~87: Consider using a different verb to strengthen your wording.
Context: ... data about your repository in order to make subsquent code reviews faster. If this conflicts with your organizati...

(MAKE_XXX_FASTER)


[misspelling] ~94-~94: This word is normally spelled as one.
Context: ...ites thorough code reviews with several sub-sections. If you'd rather have CodeRabbit genera...

(EN_COMPOUNDS_SUB_SECTIONS)


[typographical] ~94-~94: Consider adding a comma.
Context: ...ave CodeRabbit generated shorter reviews then you can change some of the following se...

(IF_THEN_COMMA)


[duplication] ~108-~108: Possible typo: you repeated a word.
Context: ...irect CodeRabbit to treat various files and and locations in your repository differentl...

(ENGLISH_WORD_REPEAT_RULE)


[style] ~119-~119: Consider removing “of” to be more concise
Context: ...ame review instructions and contexts to all of the pull requests that it generates, regard...

(ALL_OF_THE)

🪛 markdownlint-cli2 (0.17.2)
docs/guides/initial-configuration.md

123-123: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)


127-127: Hard tabs
Column: 1

(MD010, no-hard-tabs)


129-129: Hard tabs
Column: 8

(MD010, no-hard-tabs)


130-130: Hard tabs
Column: 9

(MD010, no-hard-tabs)


131-131: Hard tabs
Column: 8

(MD010, no-hard-tabs)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (5)
sidebars.ts (2)

82-86:Approve new configuration guide entries
The new sidebar items for configuration (configuration-overview,organization-settings,repository-settings,initial-configuration) are correctly inserted under “Configure CodeRabbit.”


168-169:Approve new reference entry
Thereference/configuration link is properly added afterreference/review-commands in the “Reference” category.

docs/guides/repository-settings.md (1)

1-5:Frontmatter looks correct
The YAML header defines title and description appropriately.

docs/guides/configuration-overview.md (1)

1-5:Frontmatter and sidebar label are correct
No issues with the YAML header orsidebar_label.

docs/guides/initial-configuration.md (1)

1-4:Frontmatter is valid
YAML header correctly defines title and description.

@jmacdotorg
Copy link
ContributorAuthor

@coderabbitai summary

coderabbitai[bot] reacted with eyes emoji

@coderabbitaicoderabbitai
Copy link
Contributor

✅ Actions performed

Summary regeneration triggered.

Copy link
Contributor

@coderabbitaicoderabbitaibot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/guides/repository-settings.md (3)

21-21:Fix article usage (“and” → “an”).

Grammar nit: use “an easier way” instead of “and easier way”.

-While the web interface provides and easier way to explore the available configuration options for your repository,+While the web interface provides an easier way to explore the available configuration options for your repository,

25-25:Correct typos in the introductory sentence.

Replace “of” → “or”, fix “repsository” spelling.

-To view of modify your repsository settings using the CodeRabbit web interface, follow these steps:+To view or modify your repository settings using the CodeRabbit web interface, follow these steps:

30-30:Slight wording tweak for clarity.

“organization-configuration page” is awkward; “organization settings page” is clearer.

-then CodeRabbit applies the settings you have set through [the organization-configuration page](/guides/organization-settings) to this repository.+then CodeRabbit applies the settings you have set through the [organization settings page](/guides/organization-settings) to this repository.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and betweencd87ee0 and89ad6fb.

📒 Files selected for processing (1)
  • docs/guides/repository-settings.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/repository-settings.md

[uncategorized] ~21-~21: “and” (in addition to, following this) seems less likely than “an” (indefinite article before a vowel sound).
Context: ...face. While the web interface provides and easier way to explore the available con...

(AI_HYDRA_LEO_CP_AND_AN)


[uncategorized] ~25-~25: “of” seems less likely than “or” (‘either … or’).
Context: ...ng the web interface {#modify} To view of modify your repsository settings using ...

(AI_HYDRA_LEO_CP_OF_OR)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test
  • GitHub Check: Cloudflare Pages

@smb06
Copy link
Contributor

smb06 commentedJun 23, 2025
edited
Loading

@jmacdotorg - Love the new yaml template! Thank you. As a fast-follow project, maybe we should also add the description and value type for each of the config options in the .yaml (using what is in the schema) as in-line comments, but not a blocker for now.

@smb06
Copy link
Contributor

@jmacdotorg - I think we might also want to loop in the "Best Practices" chapter under the "Configure CodeRabbit" chapter as a sub-section (and maybe call it "Best practices & Configuration"). I will confirm after talking to a few other folks. Not a blocker for now.

@jmacdotorgjmacdotorg requested a review fromsmb06June 24, 2025 18:22
Copy link
Contributor

@coderabbitaicoderabbitaibot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/guides/organization-settings.md (3)

13-15:Tighten wording to remove redundancy

Removing “of” makes the sentence crisper without losing meaning.

- for all of the Git repositories associated with your organization.+ for all Git repositories associated with your organization.

16-18:Minor phrasing & comma cleanup

The trailing comma beforeinstead breaks the flow and “individual” is implicit.

-You have the option to define separate settings for some or-all of your individual repositories, instead.+You can define separate settings for some or all repositories instead.

6-8:Consider a more concise opener

The current sentence is slightly long. A shorter alternative:

-This page is about managing the default settings of CodeRabbit across your-whole Git platform organization.+Learn how to manage your organization-wide default CodeRabbit settings.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and betweena245c09 andacda0e6.

📒 Files selected for processing (2)
  • docs/guides/organization-settings.md (1 hunks)
  • docs/guides/repository-settings.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/guides/repository-settings.md
🧰 Additional context used
🪛 LanguageTool
docs/guides/organization-settings.md

[style] ~14-~14: Consider removing “of” to be more concise
Context: ...to set the CodeRabbit configuration for all of the Git repositories associated with your o...

(ALL_OF_THE)

🔇 Additional comments (1)
docs/guides/organization-settings.md (1)

21-26:Double-check navigation path & URL

Step 1 links directly to/settings/repositories, but the next line instructs the user to clickOrganization Settings. Usually the organization-level URL is/settings/organizations (or similar).

Please verify the actual path in the UI so users aren’t dropped into the repository-scoped page by mistake.

@jmacdotorgjmacdotorg requested a review fromsmb06June 24, 2025 22:01
Copy link
Contributor

@coderabbitaicoderabbitaibot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/guides/configuration-overview.md (2)

47-47:Fix article typo (“and” → “an”).

Minor grammatical slip; keeps the prose polished.

-While the web interface provides and easier way to explore the available configuration options for your repository, we recommend using a `.coderabbit.yaml` file [as a best practice](/guides/setup-best-practices#yaml).+While the web interface provides an easier way to explore the available configuration options for your repository, we recommend using a `.coderabbit.yaml` file [as a best practice](/guides/setup-best-practices#yaml).

39-40:Reword to avoid repetitive “If you want to apply …” phrasing.

This mirrors the sentence structure used two sections above; varying it keeps the flow fresh.

-If you want to apply separate CodeRabbit configuration to your organization's different repositories, then you can-manage repository-specific CodeRabbit settings in two ways:+To apply distinct CodeRabbit configurations to different repositories within your organization, you can manage repository-specific settings in two ways:
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between3fe0701 and7bc89a2.

📒 Files selected for processing (2)
  • docs/guides/configuration-overview.md (1 hunks)
  • docs/guides/repository-settings.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/guides/repository-settings.md
🧰 Additional context used
🪛 LanguageTool
docs/guides/configuration-overview.md

[style] ~39-~39: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...### Repository settings {#repo} If you want to apply separate CodeRabbit configuration...

(REP_WANT_TO_VB)


[uncategorized] ~47-~47: “and” (in addition to, following this) seems less likely than “an” (indefinite article before a vowel sound).
Context: ...ngs). While the web interface provides and easier way to explore the available con...

(AI_HYDRA_LEO_CP_AND_AN)

Copy link
Contributor

@coderabbitaicoderabbitaibot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/guides/organization-settings.md (1)

13-14:Tighten wording for concision

Dropping the unnecessary “of” makes the sentence read more smoothly.

- for all of the Git repositories associated with your organization.+ for all the Git repositories associated with your organization.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between7bc89a2 and6eb1fa9.

📒 Files selected for processing (2)
  • docs/guides/organization-settings.md (1 hunks)
  • docs/guides/repository-settings.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/guides/repository-settings.md
🧰 Additional context used
🪛 LanguageTool
docs/guides/organization-settings.md

[style] ~14-~14: Consider removing “of” to be more concise
Context: ...to set the CodeRabbit configuration for all of the Git repositories associated with your o...

(ALL_OF_THE)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test
🔇 Additional comments (1)
docs/guides/organization-settings.md (1)

23-25:Double-check deep link path

https://app.coderabbit.ai/settings/repositories currently lands on therepository-level settings page, not the organization settings page referenced in step 2.
Verify the URL and update if needed to avoid confusing readers.

@jmacdotorgjmacdotorg marked this pull request as ready for reviewJune 24, 2025 23:55
@jmacdotorgjmacdotorgenabled auto-merge (squash)June 24, 2025 23:57
Copy link
Contributor

@howonleehowonlee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

lmao

@jmacdotorgjmacdotorg merged commitf17aa48 intomainJun 25, 2025
4 checks passed
@jmacdotorgjmacdotorg deleted the config branchJune 25, 2025 00:02
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] approved these changes

@howonleehowonleehowonlee approved these changes

@smb06smb06smb06 approved these changes

@yashshankeryashshankerAwaiting requested review from yashshankeryashshanker was automatically assigned from coderabbitai/typescript-reviewers

@helizagahelizagaAwaiting requested review from helizagahelizaga was automatically assigned from coderabbitai/typescript-reviewers

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@jmacdotorg@smb06@howonlee

[8]ページ先頭

©2009-2025 Movatter.jp