Skip to content

Commit e78c297

Browse files
add note on changing overall title
1 parent 09e33bf commit e78c297

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/guides/custom-reports.md

+12
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,18 @@ CodeRabbit supports markdown formatting in custom reports. You can use:
133133
- Bold and italic text
134134
- Links
135135

136+
### Headers and Titles
137+
138+
The name you give to each report in the CodeRabbit menu will be used for the first line of any report or the subject for emails. For example if your report is named `Executive Summary Template` then this string will appear on the subject of your emails and start of all message chains.
139+
140+
The reports will also have an overall title describing the report content such as `Pull Request Summary Report (January 2025)`.
141+
142+
To change these details of this overall title you should include specific instructions in your custom prompt with examples such as:
143+
144+
```
145+
- Do not add a date to the titles like "Pull Request Summary Report (January 2025)" it should just be "Pull Request Summary Report"
146+
```
147+
136148
### Language Support
137149

138150
You can generate reports in multiple languages by specifying the ISO language code in your template. For example:

0 commit comments

Comments
 (0)