issue chat docs #254
issue chat docs #254
Conversation
WalkthroughA new documentation file, "Issue Chat", has been added under the docs guides. This file details how developers can integrate CodeRabbit’s chat functionalities within GitHub and GitLab issues by mentioning a bot. It explains features such as code analysis, agentic thought chain processing, command line tool access, repository historical insights, and various use cases. The document also provides examples, images, and best practices for effective use. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant IT as Issue Tracker (GitHub/GitLab)
participant Bot as CodeRabbit Bot
participant CI as Chat Interface
Dev->>IT: Post issue comment mentioning @CodeRabbitBot
IT->>Bot: Forward comment to CodeRabbit Bot
Bot->>CI: Process natural language query
CI-->>Bot: Return analysis and response details
Bot-->>IT: Post formatted response in issue comment
Possibly related PRs
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
Deploying coderabbit-docs with
|
| Latest commit: |
47f982d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://68e7d9ac.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://feat-issue-chat-documentatio.coderabbit-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/guides/issue-chat.md (6)
14-17: Enhance Compound Adjective Formatting in Introduction
In line 16, the phrase "create AI powered code searches" should use a hyphen for the compound adjective. Consider updating it as follows:- create AI powered code searches + create AI-powered code searchesAdditionally, you might consider whether a more emphatic adjective could further strengthen the description, but the current wording is acceptable if preferred.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~16-~16: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... code, get answers to questions, create AI powered code searches, plan features, and gain ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~16-~16: Consider an alternative adjective to strengthen your wording.
Context: ... code searches, plan features, and gain deeper insights into their codebase - all with...(DEEP_PROFOUND)
18-20: Consider Preposition Adjustment in Getting Started Section
The sentence "To start a conversation with CodeRabbit in any issue:" may be clearer with a slight preposition change. For example:- To start a conversation with CodeRabbit in any issue: + To start a conversation with CodeRabbit on any issue:This change might better reflect the context in which the conversation is initiated.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...To start a conversation with CodeRabbit in any issue: 1. Simply mention `@coderab...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
46-54: Correct Compound Adjective in Capability Description
Within the list under "This allows CodeRabbit to:", the bullet "Create AI powered code searches" should be updated with proper hyphenation:- - Create AI powered code searches + - Create AI-powered code searchesThis ensures that the compound adjective is correctly formatted.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...are answers about the codebase - Create AI powered code searches - Use tribal knowledge fr...(EN_COMPOUND_ADJECTIVE_INTERNAL)
80-82: Hyphenate Compound Adjective in Open Source Support Section
The sentence "CodeRabbit can help maintain open source projects by:" should hyphenate "open source" when used as a compound adjective. A suggested update would be:- CodeRabbit can help maintain open source projects by: + CodeRabbit can help maintain open-source projects by:This adjustment aligns with common style guidelines.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~80-~80: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ning.png) ## Additional Use Cases ### Open Source Support CodeRabbit can help maintain o...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~82-~82: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e Support CodeRabbit can help maintain open source projects by: - Answering common suppor...(EN_COMPOUND_ADJECTIVE_INTERNAL)
95-101: Hyphenate Compound Adjective in Documentation Assistance
Under the "Documentation Assistance" section, change "Generate high level documentation" to use a hyphen in "high-level":- - Generate high level documentation + - Generate high-level documentationThis refines the readability and adheres to standard English compound adjective rules.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~97-~97: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...istance Use issue chat to: - Generate high level documentation - Create usage examples a...(EN_COMPOUND_ADJECTIVE_INTERNAL)
147-155: Fix Hyphenation for Compound Adjective in Best Practices
In the Best Practices section, on the bullet that advises "ask follow up questions," update the phrase to "ask follow-up questions" for proper hyphenation:- - Use multiple messages to ask follow up questions if needed + - Use multiple messages to ask follow-up questions if neededThis improvement ensures stylistic consistency across the document.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (9)
static/img/guides/agentic-thought-chain.pngis excluded by!**/*.png,!**/*.pngstatic/img/guides/chat-example.pngis excluded by!**/*.png,!**/*.pngstatic/img/guides/chat-learnings-use.pngis excluded by!**/*.png,!**/*.pngstatic/img/guides/chat-script-execution.pngis excluded by!**/*.png,!**/*.pngstatic/img/guides/feature-planning.pngis excluded by!**/*.png,!**/*.pngstatic/img/guides/gitlab-issue-chat.pngis excluded by!**/*.png,!**/*.pngstatic/img/guides/high-level-docs.pngis excluded by!**/*.png,!**/*.pngstatic/img/guides/marketing-posts.pngis excluded by!**/*.png,!**/*.pngstatic/img/guides/open-source-support.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (1)
docs/guides/issue-chat.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/issue-chat.md
[uncategorized] ~16-~16: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... code, get answers to questions, create AI powered code searches, plan features, and gain ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~16-~16: Consider an alternative adjective to strengthen your wording.
Context: ... code searches, plan features, and gain deeper insights into their codebase - all with...
(DEEP_PROFOUND)
[uncategorized] ~20-~20: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...To start a conversation with CodeRabbit in any issue: 1. Simply mention `@coderab...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[uncategorized] ~52-~52: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...are answers about the codebase - Create AI powered code searches - Use tribal knowledge fr...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~80-~80: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ning.png) ## Additional Use Cases ### Open Source Support CodeRabbit can help maintain o...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~82-~82: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e Support CodeRabbit can help maintain open source projects by: - Answering common suppor...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~97-~97: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...istance Use issue chat to: - Generate high level documentation - Create usage examples a...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~144-~144: ‘follow up’ seems to be a compound adjective before a noun. Use a hyphen: “follow-up”.
Context: ... ones - Use multiple messages to ask follow up questions if needed ## Related Resourc...
(CA_FOLLOW_UP)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
docs/guides/issue-chat.md (2)
1-6: YAML Front Matter Structured Correctly
The front matter is clear and well-defined, with an appropriate title, sidebar label, description, and position for the document.
8-12: MDX Code Block Implementation Looks Good
The MDX code block properly imports theProPlanNoticecomponent and renders it.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/guides/issue-chat.md (6)
14-17: Introduction Clarity & Compound Adjective Hyphenation.
The introductory section is comprehensive and clearly outlines the capabilities. However, on line 16, consider hyphenating compound adjectives for clarity. For example, change “AI powered code searches” to “AI-powered code searches.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~16-~16: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... code, get answers to questions, create AI powered code searches, plan features, and gain ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~16-~16: Consider an alternative adjective to strengthen your wording.
Context: ... code searches, plan features, and gain deeper insights into their codebase - all with...(DEEP_PROFOUND)
18-20: Preposition Choice in Instructions.
The “Getting Started” section is easy to follow. One minor suggestion: on line 20, consider replacing “in any issue” with “on any issue” for improved clarity when referring to comment threads.🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...To start a conversation with CodeRabbit in any issue: 1. Simply mention `@coderab...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
52-52: Hyphenate Compound Adjectives in Bullet Points.
In the “Core Capabilities” section, the bullet point “Create AI powered code searches” on line 52 should use a hyphen, i.e. “AI-powered code searches,” to follow style conventions.🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...are answers about the codebase - Create AI powered code searches - Use tribal knowledge fr...(EN_COMPOUND_ADJECTIVE_INTERNAL)
80-82: Hyphenation for Compound Modifiers.
Within the “Open Source Support” section (lines 80–82), consider hyphenating “open source projects” to “open-source projects” since it acts as a compound adjective.🧰 Tools
🪛 LanguageTool
[uncategorized] ~80-~80: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ning.png) ## Additional Use Cases ### Open Source Support Issue chat, like all Pro CodeR...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~82-~82: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ll Pro CodeRabbit features, is free for open source projects. CodeRabbit acts as a powerful...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~82-~82: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...bit acts as a powerful support tool for open source maintainers by: - Answering common use...(EN_COMPOUND_ADJECTIVE_INTERNAL)
97-101: Improve Compound Adjective Formatting.
In the “Documentation Assistance” section, change “high level descriptions” and “high level documentation” to “high-level descriptions” and “high-level documentation” respectively for better readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~99-~99: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... Assistance Use issue chat to generate high level descriptions of the code and services i...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...n.so/help/guides) and more: - Generate high level documentation - Create usage examples a...(EN_COMPOUND_ADJECTIVE_INTERNAL)
148-149: Grammar: Hyphenate “Follow-up.”
In the Best Practices section (lines 148–149), change “follow up questions” to “follow-up questions” to comply with compound adjective conventions.🧰 Tools
🪛 LanguageTool
[grammar] ~148-~148: ‘follow up’ seems to be a compound adjective before a noun. Use a hyphen: “follow-up”.
Context: ... ones - Use multiple messages to ask follow up questions if needed ## Related Resourc...(CA_FOLLOW_UP)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/issue-chat.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/issue-chat.md
[uncategorized] ~16-~16: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... code, get answers to questions, create AI powered code searches, plan features, and gain ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~16-~16: Consider an alternative adjective to strengthen your wording.
Context: ... code searches, plan features, and gain deeper insights into their codebase - all with...
(DEEP_PROFOUND)
[uncategorized] ~20-~20: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...To start a conversation with CodeRabbit in any issue: 1. Simply mention `@coderab...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[uncategorized] ~52-~52: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...are answers about the codebase - Create AI powered code searches - Use tribal knowledge fr...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~80-~80: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ning.png) ## Additional Use Cases ### Open Source Support Issue chat, like all Pro CodeR...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~82-~82: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ll Pro CodeRabbit features, is free for open source projects. CodeRabbit acts as a powerful...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~82-~82: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...bit acts as a powerful support tool for open source maintainers by: - Answering common use...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~99-~99: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... Assistance Use issue chat to generate high level descriptions of the code and services i...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...n.so/help/guides) and more: - Generate high level documentation - Create usage examples a...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~148-~148: ‘follow up’ seems to be a compound adjective before a noun. Use a hyphen: “follow-up”.
Context: ... ones - Use multiple messages to ask follow up questions if needed ## Related Resourc...
(CA_FOLLOW_UP)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (3)
docs/guides/issue-chat.md (3)
1-7: Front Matter Completeness.
The front matter is clear and well-organized with title, sidebar_label, description, and sidebar_position. Consider adding additional metadata (e.g., author or date) if your site guidelines require it.
8-13: MDX Code Block Validation.
The MDX code block correctly imports and renders theProPlanNoticecomponent. Please verify that the component path (@site/src/components/ProPlanNotice.mdx) is correct and that the component is available in the specified directory.
1-156: Overall Documentation Quality.
The new “Issue Chat” documentation is comprehensive, well-structured, and enriched with useful examples and visuals. Addressing the minor stylistic nitpicks—especially around compound adjectives and preposition use—will further enhance clarity and professionalism.🧰 Tools
🪛 LanguageTool
[uncategorized] ~16-~16: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... code, get answers to questions, create AI powered code searches, plan features, and gain ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~16-~16: Consider an alternative adjective to strengthen your wording.
Context: ... code searches, plan features, and gain deeper insights into their codebase - all with...(DEEP_PROFOUND)
[uncategorized] ~20-~20: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...To start a conversation with CodeRabbit in any issue: 1. Simply mention `@coderab...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[uncategorized] ~52-~52: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...are answers about the codebase - Create AI powered code searches - Use tribal knowledge fr...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~80-~80: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ning.png) ## Additional Use Cases ### Open Source Support Issue chat, like all Pro CodeR...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~82-~82: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ll Pro CodeRabbit features, is free for open source projects. CodeRabbit acts as a powerful...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~82-~82: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...bit acts as a powerful support tool for open source maintainers by: - Answering common use...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~99-~99: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... Assistance Use issue chat to generate high level descriptions of the code and services i...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...n.so/help/guides) and more: - Generate high level documentation - Create usage examples a...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~148-~148: ‘follow up’ seems to be a compound adjective before a noun. Use a hyphen: “follow-up”.
Context: ... ones - Use multiple messages to ask follow up questions if needed ## Related Resourc...(CA_FOLLOW_UP)
No description provided.