@@ -88,32 +88,20 @@ CodeRabbit can help maintain open source projects by:
88
88
89
89
Example:
90
90
91
- ``` text
92
- User: @coderabbitai I'm getting "TypeError: Cannot read property 'config' of undefined"
93
-
94
- CodeRabbit: Let me help troubleshoot that error...
95
-
96
- [Detailed explanation and solution steps]
97
- ```
91
+ ![ Open Source Support Example] ( ../../static/img/guides/open-source-support.png )
98
92
99
93
### Documentation Assistance
100
94
101
95
Use issue chat to:
102
96
103
- - Generate API documentation
104
- - Create usage examples
105
- - Update README files
97
+ - Generate high level documentation
98
+ - Create usage examples and mermaid diagrams
99
+ - Provide content to assist in updating README files
106
100
- Write tutorials
107
101
108
102
Example:
109
103
110
- ``` text
111
- User: @coderabbitai Can you help document the new authentication middleware?
112
-
113
- CodeRabbit: I'll analyze the middleware and create documentation...
114
-
115
- [Generated documentation with examples]
116
- ```
104
+ ![ Documentation Assistance Example] ( ../../static/img/guides/high-level-docs.png )
117
105
118
106
### Marketing Content Generation
119
107
@@ -126,13 +114,7 @@ CodeRabbit can assist with creating:
126
114
127
115
Example:
128
116
129
- ``` text
130
- User: @coderabbitai Help me write a Reddit post about our new GraphQL features
131
-
132
- CodeRabbit: I'll create a draft post highlighting the key features...
133
-
134
- [Generated Reddit post with technical details and benefits]
135
- ```
117
+ ![ Marketing Content Example] ( ../../static/img/guides/marketing-posts.png )
136
118
137
119
## Best Practices
138
120
@@ -151,10 +133,16 @@ CodeRabbit: I'll create a draft post highlighting the key features...
151
133
- Use issue chat to document decisions
152
134
- Reference related issues or PRs
153
135
136
+ 4 . ** Keep Questions Focused**
137
+ - CodeRabbit works best with clear, specific questions
138
+ - Link to specific files, directories or pull requests to help refine answers and provide better context
139
+ - CodeRabbit does not generate API documentation, Swagger specs, or other technical documentation that requires high accuracy
140
+ - Break down complex questions into smaller, more manageable ones
141
+ - Use multiple messages to ask follow up questions if needed
142
+
154
143
## Related Resources
155
144
156
145
- [ Agentic Chat] ( ./agent_chat.md )
157
146
- [ Issue Creation] ( ./issue-creation.md )
158
147
- [ Commands] ( ./commands.md )
159
-
160
- Need help? Join our community on [ Discord] ( https://discord.gg/coderabbit ) or contact our support team.
148
+ - [ Tooling Guide] ( ./tooling.md )
0 commit comments