add rate limits for extension and update agent docs #427
Conversation
Deploying coderabbit-docs with
|
| Latest commit: |
c8fa1e4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://17c7144b.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://docs-vscode-rate-limits.coderabbit-docs.pages.dev |
WalkthroughDocumentation for the CodeRabbit VSCode extension was updated. The FAQ now includes IDE extension review rate limits per plan. The VSCode configuration guide clarifies how to access settings, adds new agent types, and details their setup. The usage guide now states that automatic review prompts appear after Git commits made via both VSCode and the terminal. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
✨ 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.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/guides/use-vscode.md (1)
21-22: Clarify wording & add missing article“Perform a Git commit using VSCode or terminal” reads a bit abrupt and the list item lacks the before terminal. Consider:
-1. Perform a Git commit using VSCode or terminal. After you do this, a dialog appears in your VSCode window, asking **Would you like to start a review?** +1. Perform a Git commit using VSCode or **the** terminal. After you do this, a dialog appears in your VSCode window asking, **Would you like to start a review?**docs/faq.md (1)
208-215: Table formatting ‑ spacing & consistencyMinor polish:
- Insert a space before the parenthesis in “1/hour(Lite)”.
- Align the “N/A” column text with surrounding spacing for consistency.
-| Reviews per hour (IDE Extension) | 1/hour | 1/hour | N/A | 5/hour (Pro), 1/hour(Lite) | +| Reviews per hour (IDE Extension) | 1/hour | 1/hour | N/A | 5/hour (Pro), 1/hour (Lite) |docs/guides/config-vscode.md (2)
17-22: Improve grammar & readability of stepsArticles and hyphenation are missing, and “gear shaped” should be “gear-shaped”.
-1. Open the CodeRabbit activity bar/sidebar. -1. In the sidebar, click on gear shaped icon on top right(beside logout icon). -1. You can also search for CodeRabbit: Settings in the command palette to open the settings. +1. Open the CodeRabbit sidebar from the activity bar. +1. In that sidebar, click the **gear-shaped** icon in the **top-right corner** (beside the logout icon). +1. Alternatively, open the command palette and search for **“CodeRabbit: Settings”**.
35-42: Reduce repetition & apply consistent phrasing in new agent descriptionsEach bullet repeats “You need to have … installed for this option to be effective.” Once is enough; move the requirement to a single sentence after the list.
Example revision:
- **Codex CLI**: The extension opens the Terminal pane of your IDE and tries to use the `codex` command-line program to apply the suggested fix to your code. You need to have Codex CLI installed for this option to be effective. - **Cline**: The extension opens the `Cline` sidebar and runs a task to apply the suggested fix to your code. You need to have the `Cline` extension installed for this option to be effective. - **Roo**: The extension opens the `Roo` sidebar and runs a task to apply the suggested fix to your code. You need to have the `Roo` extension installed for this option to be effective. - **Kilo Code**: The extension opens the `Kilo Code` sidebar and runs a task to apply the suggested fix to your code. You need to have the `Kilo Code` extension installed for this option to be effective. + **Codex CLI**: Opens the terminal and runs the `codex` command-line program to apply the fix. + **Cline**: Opens the **Cline** sidebar and runs a task to apply the fix. + **Roo**: Opens the **Roo** sidebar and runs a task to apply the fix. + **Kilo Code**: Opens the **Kilo Code** sidebar and runs a task to apply the fix. + +All four options require the corresponding tool/extension to be installed beforehand.This removes duplication and tightens the text.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/faq.md(1 hunks)docs/guides/config-vscode.md(2 hunks)docs/guides/use-vscode.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
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.
docs/guides/use-vscode.md (2)
Learnt from: NatoBoram
PR: coderabbitai/coderabbit-docs#125
File: CONTRIBUTING.md:60-65
Timestamp: 2024-10-31T17:01:26.168Z
Learning: 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: 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/config-vscode.md (2)
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: 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.
🪛 LanguageTool
docs/guides/config-vscode.md
[uncategorized] ~19-~19: You might be missing the article “the” here.
Context: ...r/sidebar. 1. In the sidebar, click on gear shaped icon on top right(beside logout ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~19-~19: You might be missing the article “the” here.
Context: ...e sidebar, click on gear shaped icon on top right(beside logout icon). 1. You can ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~19-~19: You might be missing the article “the” here.
Context: ...on gear shaped icon on top right(beside logout icon). 1. You can also search for Code...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~37-~37: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ply the suggested fix to your code. You need to have the Cline extension installed fo...
(REP_NEED_TO_VB)
[style] ~39-~39: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ply the suggested fix to your code. You need to have the Roo extension installed for ...
(REP_NEED_TO_VB)
[style] ~41-~41: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ply the suggested fix to your code. You need to have the Kilo Code extension installe...
(REP_NEED_TO_VB)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: test
- GitHub Check: Cloudflare Pages
No description provided.