-
Notifications
You must be signed in to change notification settings - Fork 39
docs: Fixed typo remove duplicated 'and' (#423) #425
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughA typographical error was corrected in the documentation under the "Adjust path-specific CodeRabbit behavior" section. The phrase "files and and locations" was changed to "files and locations." No other content or structural changes were made. Changes
Assessment against linked issues
Poem
✨ Finishing Touches🧪 Generate Unit Tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support 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 (
|
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/guides/initial-configuration.md (5)
26-27
: Grammar issues blur the intent of the paragraph.
Two small tweaks tighten the prose and avoid reader confusion.-CodeRabbit temporarily stores information about your repositories in order to tailored reviews more quickly and better tailored to your team's needs. You can opt of these features if your organization has stricter data-retention policies. +CodeRabbit temporarily stores information about your repositories in order to tailor reviews more quickly and better adapt them to your team's needs. You can opt out of these features if your organization has stricter data-retention policies.
66-66
: Verb form is incorrect.-If you'd rather have CodeRabbit generated shorter reviews +If you'd rather have CodeRabbit generate shorter reviews
73-73
: Broken anchor in link label.-[Related pull requests](/reference/configuration#realted-prs) +[Related pull requests](/reference/configuration#related-prs)
75-75
: Spelling typo: “reveiwers”.-[Suggested reviewers](/reference/configuration#suggested-reveiwers) +[Suggested reviewers](/reference/configuration#suggested-reviewers)
184-184
: Article misuse.-As with an generative AI technology, +As with a generative AI technology,
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/initial-configuration.md
(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the `/img/` directory, not `/static/img/`.
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: 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.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: 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: tyaga001
PR: coderabbitai/coderabbit-docs#155
File: docs/getting-started/quickstart.md:22-22
Timestamp: 2024-11-28T16:45:08.224Z
Learning: In the `coderabbitai/coderabbit-docs` repository, when reviewing markdown files, image paths that start with `/img/` are correct and should not include the `static` prefix, even though the images are located in the `static/` directory.
Learnt from: NatoBoram
PR: coderabbitai/coderabbit-docs#165
File: docs/finishing-touches/docstrings.md:9-9
Timestamp: 2024-12-05T21:29:59.510Z
Learning: The link `/future-developments#finishing-touches` in `docs/finishing-touches/docstrings.md` is correct and should not be flagged as incorrect in future reviews.
docs/guides/initial-configuration.md (6)
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the `/img/` directory, not `/static/img/`.
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: 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.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: 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: tyaga001
PR: coderabbitai/coderabbit-docs#155
File: docs/getting-started/quickstart.md:22-22
Timestamp: 2024-11-28T16:45:08.224Z
Learning: In the `coderabbitai/coderabbit-docs` repository, when reviewing markdown files, image paths that start with `/img/` are correct and should not include the `static` prefix, even though the images are located in the `static/` directory.
Learnt from: NatoBoram
PR: coderabbitai/coderabbit-docs#165
File: docs/finishing-touches/docstrings.md:9-9
Timestamp: 2024-12-05T21:29:59.510Z
Learning: The link `/future-developments#finishing-touches` in `docs/finishing-touches/docstrings.md` is correct and should not be flagged as incorrect in future reviews.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#176
File: docs/self-hosted/bitbucket.md:37-37
Timestamp: 2024-12-13T15:10:43.483Z
Learning: In the `docs` repository, it's acceptable to use `127.0.0.1` in documentation examples, and CodeRabbit should not flag it as an issue.
🔇 Additional comments (1)
docs/guides/initial-configuration.md (1)
80-81
: Typo fix confirmed — good catch.
The duplicated “and” is removed, the sentence now reads correctly.
already opened PR, no need for this one |
Removed the duplicated "and" from the initial-configuration.md file
This fixes #423