Skip to content

issue chat docs #254

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

Merged
merged 6 commits into from
Mar 25, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add more pics and cleanup
  • Loading branch information
alexcoderabbitai committed Mar 25, 2025
commit c35570a195a86dde795d89532e15f2e9ed698c31
40 changes: 14 additions & 26 deletions docs/guides/issue-chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,32 +88,20 @@ CodeRabbit can help maintain open source projects by:

Example:

```text
User: @coderabbitai I'm getting "TypeError: Cannot read property 'config' of undefined"

CodeRabbit: Let me help troubleshoot that error...

[Detailed explanation and solution steps]
```
![Open Source Support Example](../../static/img/guides/open-source-support.png)

### Documentation Assistance

Use issue chat to:

- Generate API documentation
- Create usage examples
- Update README files
- Generate high level documentation
- Create usage examples and mermaid diagrams
- Provide content to assist in updating README files
- Write tutorials

Example:

```text
User: @coderabbitai Can you help document the new authentication middleware?

CodeRabbit: I'll analyze the middleware and create documentation...

[Generated documentation with examples]
```
![Documentation Assistance Example](../../static/img/guides/high-level-docs.png)

### Marketing Content Generation

Expand All @@ -126,13 +114,7 @@ CodeRabbit can assist with creating:

Example:

```text
User: @coderabbitai Help me write a Reddit post about our new GraphQL features

CodeRabbit: I'll create a draft post highlighting the key features...

[Generated Reddit post with technical details and benefits]
```
![Marketing Content Example](../../static/img/guides/marketing-posts.png)

## Best Practices

Expand All @@ -151,10 +133,16 @@ CodeRabbit: I'll create a draft post highlighting the key features...
- Use issue chat to document decisions
- Reference related issues or PRs

4. **Keep Questions Focused**
- CodeRabbit works best with clear, specific questions
- Link to specific files, directories or pull requests to help refine answers and provide better context
- CodeRabbit does not generate API documentation, Swagger specs, or other technical documentation that requires high accuracy
- Break down complex questions into smaller, more manageable ones
- Use multiple messages to ask follow up questions if needed

## Related Resources

- [Agentic Chat](./agent_chat.md)
- [Issue Creation](./issue-creation.md)
- [Commands](./commands.md)

Need help? Join our community on [Discord](https://discord.gg/coderabbit) or contact our support team.
- [Tooling Guide](./tooling.md)
Binary file added static/img/guides/high-level-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/guides/marketing-posts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/guides/open-source-support.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading