Feat/add new comment tags (#246)

* adding info for using comment tags

* fix sentence

* lint fix

Author: alexcoderabbitai

docs/guides/custom-reports.md

@@ -71,6 +71,8 @@ Your custom reports can access the following PR information that you can referen
 
 #### Pull Request Status
 
+Contained within the `<pr_details>` tag.
+
 - `Merged`: boolean (true/false) - Whether the PR has been merged
 - `Draft`: boolean (true/false) - Whether the PR is in draft state
 - `State`: string ("open"/"closed") - Current state of the PR
@@ -79,6 +81,8 @@ Your custom reports can access the following PR information that you can referen
 
 #### Basic Information
 
+Contained within the `<pr_details>` tag.
+
 - `Pull request number`: number - The PR's identifier
 - `Title`: string - PR title
 - `URL`: string - Link to the PR
@@ -88,16 +92,25 @@ Your custom reports can access the following PR information that you can referen
 - `Closed at`: datetime (if applicable) - When the PR was closed
 - `Source branch`: string - Source branch name
 - `Target branch`: string - Target branch name
-
-#### Additional Context
-
 - `Labels`: array of strings - All labels applied to the PR
 - `Reviewers`: array of strings - Assigned reviewers' usernames
-- `Description`: markdown - Full PR description
-- `Summary`: string - AI-generated summary of changes
-- `Comments`: array of objects
-  - `username`: string - Comment author
-  - `body`: markdown - Comment content
+
+#### Summarized PR Details
+
+- `<pr_description>`: string - Contains the body of your pull request (aka the PR description at the top of the PR page).
+- `<file_changes_summary>`: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AI durring the PR review process. This includes several sections for each file that was changed:
+  - `filename`: string - The name of the file that was changed.
+  - `AI-generated summary of changes`: markdown - An overall summary of the changes made in the file.
+  - `Alterations to the declarations of exported or public entities`: markdown - A more specific breakdown of the changes made to the file such as exactly what was added, removed, or modified.
+
+#### Comments
+
+- `<pr_comments>`: array of comment objects - Contains all the comments made on the PR.
+- `<comment>`: object - Each indidvidual comment is wrapped in this tag and is an object with the following properties:
+  - `<comment_author_username>`: string - The username of the comment author.
+  - `<comment_created_at>`: datetime - The date and time the comment was created.
+  - `<comment_updated_at>`: datetime - The date and time the comment was last updated.
+  - `<comment_body>`: markdown - The content of the comment.
 
 Here's an example prompt that uses these data points: