info/report-titles (#188)

* update note on custom reports

* add note on changing overall title

* fix text

* add note on examples

* 🎨 pnpm run lint:fix

[dependabot skip]

* add preview note

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: alexcoderabbitai

docs/guides/custom-reports.md

@@ -133,6 +133,20 @@ CodeRabbit supports markdown formatting in custom reports. You can use:
 - Bold and italic text
 - Links
 
+### Headers and Titles
+
+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.
+
+When using the `Preview Report` button in the CodeRabbit menu, the subject will begin with `Preview: <report name>`.
+
+The reports will also have an overall title describing the report content such as `Pull Request Summary Report (January 2025)`.
+
+To change these details of this overall title you should include specific instructions in your custom prompt with examples such as:
+
+```text
+- Do not add a date to the titles like "Pull Request Summary Report (January 2025)" it should just be "Pull Request Summary Report"
+```
+
 ### Language Support
 
 You can generate reports in multiple languages by specifying the ISO language code in your template. For example:
@@ -210,10 +224,18 @@ Provide:
    - Consider your audience's needs
 
 4. **Optimize Readability**
+
    - Use appropriate formatting
    - Include visual breaks
    - Maintain consistent styling
 
+5. **Use Examples**
+   - Include "do this" and "don't do this" examples (especially for titles)
+   - Demonstrate proper formatting patterns
+   - Show concrete use cases for different report types
+   - Help maintain consistency across teams
+   - Avoid ambiguity in report generation
+
 ## Example Templates
 
 ### Executive Summary Template

docs/guides/scheduled-reports.md

@@ -97,7 +97,7 @@ CodeRabbit offers several built-in templates:
 1. **Daily Standup Report**: A concise summary of pull requests and activities.
 2. **Sprint Report**: A structured overview of sprint goals, completed tasks, in-progress work, and blockers.
 3. **Release Notes**: A high-level changelog with summary and significant changes.
-4. **[Custom Templates](./custom-reports.md)**: Create your own format using prompts. Has support for multiple languages.
+4. **[Custom Templates](custom-reports.md)**: Create your own format using prompts. Allows for endless customization such as native language reporting (Japanese, Spanish, French, etc.), custom formatting, custom titles, and more.
 
 Example custom prompt: