- Notifications
You must be signed in to change notification settings - Fork45
Simplify and clarify GitHub integration instructions#442
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
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
coderabbitaibot commentedJul 10, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
WalkthroughThe documentation for GitHub.com integration and the general platforms overview was rewritten for clarity and conciseness. The GitHub integration page now provides a streamlined, step-by-step guide with explicit permission details, while the platforms overview introduces a conceptual workflow and directs users to platform-specific guides. Redundant and overly detailed content was removed. Changes
Sequence Diagram(s)sequenceDiagram participant User participant CodeRabbit Docs User->>CodeRabbit Docs: Access platforms overview CodeRabbit Docs-->>User: Show conceptual integration steps User->>CodeRabbit Docs: Select GitHub.com integration guide CodeRabbit Docs-->>User: Show step-by-step GitHub.com setup instructions User->>GitHub: Authorize CodeRabbit app GitHub-->>User: Grant requested permissionsAssessment against linked issues
Poem
Impact AnalysisStreamlined GitHub integration documentation and removal of detailed examplesℹ️ Low 🔄 Impacts behavior Users will now find a more concise and reorganized guide for integrating CodeRabbit with GitHub.com. The instructions are clearer, with explicit steps for authorization and repository access, and permissions are listed in detail. However, all previous examples, command usage, and in-depth explanations have been removed, so users seeking detailed walkthroughs or examples will need to refer to other guides. Review the updated documentation for clarity and completeness. Verify that users can follow the new instructions to successfully integrate CodeRabbit with GitHub, and ensure that all necessary steps and permissions are clearly explained. Check for any missing information that might hinder onboarding. ✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat withCodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File ( |
cloudflare-workers-and-pagesbot commentedJul 10, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Deploying coderabbit-docs with |
| Latest commit: | 871babc |
| Status: | ✅ Deploy successful! |
| Preview URL: | https://64af7564.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://github.coderabbit-docs.pages.dev |
omar-coderabbitai commentedJul 11, 2025
@coderabbitai configuration |
CodeRabbit configurationlanguage:en-UStone_instructions:''early_access:trueenable_free_tier:truereviews:profile:chillrequest_changes_workflow:truehigh_level_summary:falsehigh_level_summary_placeholder:'@coderabbitai summary'high_level_summary_in_walkthrough:falseauto_title_placeholder:'@coderabbitai'auto_title_instructions:''review_status:truecommit_status:truefail_commit_status:falsecollapse_walkthrough:falsechanged_files_summary:truesequence_diagrams:trueassess_linked_issues:truerelated_issues:truerelated_prs:truesuggested_labels:trueauto_apply_labels:falsesuggested_reviewers:trueauto_assign_reviewers:falsepoem:truelabeling_instructions:[]path_filters: -'!dist/**' -'!**/*.app' -'!**/*.bin' -'!**/*.bz2' -'!**/*.class' -'!**/*.db' -'!**/*.csv' -'!**/*.tsv' -'!**/*.dat' -'!**/*.dll' -'!**/*.dylib' -'!**/*.egg' -'!**/*.glif' -'!**/*.gz' -'!**/*.xz' -'!**/*.zip' -'!**/*.7z' -'!**/*.rar' -'!**/*.zst' -'!**/*.ico' -'!**/*.jar' -'!**/*.tar' -'!**/*.war' -'!**/*.lo' -'!**/*.log' -'!**/*.mp3' -'!**/*.wav' -'!**/*.wma' -'!**/*.mp4' -'!**/*.avi' -'!**/*.mkv' -'!**/*.wmv' -'!**/*.m4a' -'!**/*.m4v' -'!**/*.3gp' -'!**/*.3g2' -'!**/*.rm' -'!**/*.mov' -'!**/*.flv' -'!**/*.iso' -'!**/*.swf' -'!**/*.flac' -'!**/*.nar' -'!**/*.o' -'!**/*.ogg' -'!**/*.otf' -'!**/*.p' -'!**/*.pdf' -'!**/*.doc' -'!**/*.docx' -'!**/*.xls' -'!**/*.xlsx' -'!**/*.map' -'!**/*.out' -'!**/*.ppt' -'!**/*.pptx' -'!**/*.pkl' -'!**/*.pickle' -'!**/*.pyc' -'!**/*.pyd' -'!**/*.pyo' -'!**/*.pub' -'!**/*.pem' -'!**/*.rkt' -'!**/*.so' -'!**/*.ss' -'!**/*.eot' -'!**/*.exe' -'!**/*.pb.go' -'!**/*.pb.gw.go' -'!**/*.lock' -'!**/*.ttf' -'!**/*.yaml' -'!**/*.yml' -'!**/*.xml' -'!**/*.cfg' -'!**/*.toml' -'!**/*.ini' -'!**/*.mod' -'!**/*.sum' -'!**/*.work' -'!**/*.json' -'!**/*.mmd' -'!**/*.svg' -'!**/*.jpeg' -'!**/*.jpg' -'!**/*.png' -'!**/*.gif' -'!**/*.bmp' -'!**/*.tiff' -'!**/*.webm' -'!**/*.woff' -'!**/*.woff2' -'!**/*.dot' -'!**/*.md5sum' -'!**/*.wasm' -'!**/*.snap' -'!**/*.parquet' -'!**/gen/**' -'!**/_gen/**' -'!**/generated/**' -'!**/@generated/**' -'!**/vendor/**' -'!**/*.min.js' -'!**/*.min.js.map' -'!**/*.min.js.css' -'!**/*.tfstate' -'!**/*.tfstate.backup' -''path_instructions:[]abort_on_close:truedisable_cache:falseauto_review:enabled:trueauto_incremental_review:trueignore_title_keywords:[]labels:[]drafts:truebase_branches:[]finishing_touches:docstrings:enabled:trueunit_tests:enabled:truetools:ast-grep:rule_dirs:[]util_dirs:[]essential_rules:truepackages:[]shellcheck:enabled:trueruff:enabled:falsemarkdownlint:enabled:truegithub-checks:enabled:truetimeout_ms:90000languagetool:enabled:trueenabled_rules:[]disabled_rules:[]enabled_categories:[]disabled_categories:[]enabled_only:falselevel:defaultbiome:enabled:truehadolint:enabled:falseswiftlint:enabled:falsephpstan:enabled:falselevel:defaultphpmd:enabled:truephpcs:enabled:truegolangci-lint:enabled:falseyamllint:enabled:truegitleaks:enabled:truecheckov:enabled:truedetekt:enabled:falseeslint:enabled:trueflake8:enabled:truerubocop:enabled:falsebuf:enabled:falseregal:enabled:falseactionlint:enabled:truepmd:enabled:falsecppcheck:enabled:falsesemgrep:enabled:truecircleci:enabled:trueclippy:enabled:truesqlfluff:enabled:trueprismaLint:enabled:truepylint:enabled:trueoxc:enabled:trueshopifyThemeCheck:enabled:trueluacheck:enabled:truebrakeman:enabled:truedotenvLint:enabled:truehtmlhint:enabled:truecheckmake:enabled:truechat:auto_reply:trueintegrations:jira:usage:autolinear:usage:autoknowledge_base:opt_out:falseweb_search:enabled:truecode_guidelines:enabled:truefilePatterns:[]learnings:scope:autoissues:scope:autojira:usage:autoproject_keys:[]linear:usage:autoteam_keys:[]pull_requests:scope:autocode_generation:docstrings:language:en-USpath_instructions:[]unit_tests:path_instructions:[] |
docs/platforms/github-com.md Outdated
| You can tailorCodeRabbit's functionality using the `.coderabbit.yaml` file, which you place directly in your GitHub repository. This file mirrors the options available in the CodeRabbit user interface,witheach setting in the YAML corresponding to a specific toggle in the UI. Configure CodeRabbit either through the coderabbit.yaml file or the interface, depending onyourpreference. | ||
| ### AuthorizeCodeRabbitwith yourrepositories |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Actually it was confusing as a reader on these two heading.
Authorize CodeRabbit with your repositories
Allow CodeRabbit to access your repositories
I know you were informing a way to add specific repos vs all repos or something.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Good point. Reworded line 63 to "Grant required permissions".
|  | ||
| ## Allow CodeRabbit to access your repositories |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I know you added trust center link, but it is better to add a note aka admonishment to highlight the trust center and informing the user we don't store your code by default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
OK, I wrapped this text in a note.
There was a problem hiding this 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 (5)
docs/platforms/github-com.md (5)
3-3:Tweak description wording for smoother readability
Consider swapping “add to” with “integrate into” so the sentence flows a bit more naturally.-description: Learn how to integrate CodeRabbit and add to your GitHub workflow.+description: Learn how to integrate CodeRabbit into your GitHub workflow.
17-20:Clarify required permission level
“Ownership-level permissions” is ambiguous on GitHub (possible roles:admin,maintain,ownerfor orgs). Explicitly naming the required role avoids confusion for readers who aren’t org owners but still haveadminrights on a repo.-You need to have a GitHub account, and ownership-level permissions of at least one repository associated with that account.+You need a GitHub account and at least **Admin** permission on one repository associated with that account.
23-25:Remove duplicated word
Minor typo: “you” repeated.-Before you can you use CodeRabbit with GitHub, you need to+Before you can use CodeRabbit with GitHub, you need to
46-49:Tighten phrasing for conciseness-Even after you've integrated CodeRabbit with your GitHub account, you need to-separately grant CodeRabbit the permissions that it needs to post code reviews and-create pull requests in your repositories.+After linking your GitHub account, grant CodeRabbit additional permissions so it can post reviews and open pull requests in your repositories.
55-60:Use parallel wording and slashes for permission list-- Read-only access to actions, checks, discussions, members, and metadata.-- Read-and-write access to code, commit statuses, issues, and pull requests.+- Read-only: actions, checks, discussions, members, metadata+- Read/Write: code, commit statuses, issues, pull requestsThis keeps the two bullets symmetrical and shorter.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/platforms/github-com.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: NatoBoramPR: coderabbitai/coderabbit-docs#125File: CONTRIBUTING.md:60-65Timestamp: 2024-10-31T17:01:26.168ZLearning: In the `CONTRIBUTING.md` file, the user prefers to keep the "Keeping your Fork Up-to-Date" section concise without additional comments on Git commands.Learnt from: alexcoderabbitaiPR: coderabbitai/coderabbit-docs#176File: docs/platforms/platforms.md:37-37Timestamp: 2024-12-13T15:14:22.187ZLearning: Always remind developers to add new platforms to `docs/platforms/platforms.md` and ensure they update it whenever new platforms are added.docs/platforms/github-com.md (3)
Learnt from: NatoBoramPR: coderabbitai/coderabbit-docs#125File: CONTRIBUTING.md:60-65Timestamp: 2024-10-31T17:01:26.168ZLearning: In the `CONTRIBUTING.md` file, the user prefers to keep the "Keeping your Fork Up-to-Date" section concise without additional comments on Git commands.Learnt from: alexcoderabbitaiPR: coderabbitai/coderabbit-docs#0File: :0-0Timestamp: 2025-06-02T14:07:49.512ZLearning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.Learnt from: aravindputrevuPR: coderabbitai/coderabbit-docs#402File: docs/guides/setup-best-practices.md:21-21Timestamp: 2025-06-18T09:22:07.198ZLearning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.🪛 LanguageTool
docs/platforms/github-com.md
[style] ~24-~24: Consider a more expressive alternative.
Context: ...CodeRabbit with your GitHub account. To do this, follow these steps: 1. Visit [th...
(DO_ACHIEVE)
[style] ~32-~32: Consider a more concise word here.
Context: ...f the information that CodeRabbit needs in order to integrate with your GitHub account. ...
(IN_ORDER_TO_PREMIUM)
[style] ~42-~42: Consider a more expressive alternative.
Context: ...to work with your code repositories. To do this, see the next section. ## Allow C...
(DO_ACHIEVE)
[style] ~51-~51: Consider removing “of” to be more concise
Context: ...give CodeRabbit permission to work with all of the repositories associated with a GitHub o...
(ALL_OF_THE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
docs/platforms/github-com.md (1)
32-38:Verify display name capitalization
GitHub shows the OAuth application asCodeRabbitAI, notcoderabbitai. Double-check the exact label users will see to avoid confusion during authorization.
Staged pages
Fixes#440.Fixes#441.Fixes#417.