@@ -88,32 +88,20 @@ CodeRabbit can help maintain open source projects by:
8888
8989Example:
9090
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 )
9892
9993### Documentation Assistance
10094
10195Use issue chat to:
10296
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
106100- Write tutorials
107101
108102Example:
109103
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 )
117105
118106### Marketing Content Generation
119107
@@ -126,13 +114,7 @@ CodeRabbit can assist with creating:
126114
127115Example:
128116
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 )
136118
137119## Best Practices
138120
@@ -151,10 +133,16 @@ CodeRabbit: I'll create a draft post highlighting the key features...
151133 - Use issue chat to document decisions
152134 - Reference related issues or PRs
153135
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+
154143## Related Resources
155144
156145- [ Agentic Chat] ( ./agent_chat.md )
157146- [ Issue Creation] ( ./issue-creation.md )
158147- [ 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