From 677a54c5a07a836567707c30f3e5702318f19752 Mon Sep 17 00:00:00 2001
From: ofir-frd <85901822+ofir-frd@users.noreply.github.com>
Date: Fri, 14 Mar 2025 12:02:26 +0200
Subject: [PATCH 1/2] Update review.md

---
 docs/docs/tools/review.md | 110 +++++++++++++++++++-------------------
 1 file changed, 55 insertions(+), 55 deletions(-)

diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md
index e3c3c3c6..37dfcc8e 100644
--- a/docs/docs/tools/review.md
+++ b/docs/docs/tools/review.md
@@ -51,68 +51,68 @@ extra_instructions = "..."
 
 !!! example "General options"
 
-<table>
-  <tr>
-    <td><b>persistent_comment</b></td>
-    <td>If set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.</td>
-  </tr>
-  <tr>
-  <td><b>final_update_message</b></td>
-  <td>When set to true, updating a persistent review comment during online commenting will automatically add a short comment with a link to the updated review in the pull request .Default is true.</td>
-  </tr>
-  <tr>
-    <td><b>extra_instructions</b></td>
-    <td>Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".</td>
-  </tr>
-  <tr>
-    <td><b>enable_help_text</b></td>
-    <td>If set to true, the tool will display a help text in the comment. Default is true.</td>
-  </tr>
-</table>
+    <table>
+      <tr>
+        <td><b>persistent_comment</b></td>
+        <td>If set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.</td>
+      </tr>
+      <tr>
+      <td><b>final_update_message</b></td>
+      <td>When set to true, updating a persistent review comment during online commenting will automatically add a short comment with a link to the updated review in the pull request .Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>extra_instructions</b></td>
+        <td>Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".</td>
+      </tr>
+      <tr>
+        <td><b>enable_help_text</b></td>
+        <td>If set to true, the tool will display a help text in the comment. Default is true.</td>
+      </tr>
+    </table>
 
 !!! example "Enable\\disable specific sub-sections"
 
-<table>
-  <tr>
-    <td><b>require_score_review</b></td>
-    <td>If set to true, the tool will add a section that scores the PR. Default is false.</td>
-  </tr>
-  <tr>
-    <td><b>require_tests_review</b></td>
-    <td>If set to true, the tool will add a section that checks if the PR contains tests. Default is true.</td>
-  </tr>
-  <tr>
-    <td><b>require_estimate_effort_to_review</b></td>
-    <td>If set to true, the tool will add a section that estimates the effort needed to review the PR. Default is true.</td>
-  </tr>
-  <tr>
-    <td><b>require_can_be_split_review</b></td>
-    <td>If set to true, the tool will add a section that checks if the PR contains several themes, and can be split into smaller PRs. Default is false.</td>
-  </tr>
-  <tr>
-    <td><b>require_security_review</b></td>
-    <td>If set to true, the tool will add a section that checks if the PR contains a possible security or vulnerability issue. Default is true.</td>
-  </tr>
-  <tr>
-    <td><b>require_ticket_analysis_review</b></td>
-    <td>If set to true, and the PR contains a GitHub or Jira ticket link, the tool will add a section that checks if the PR in fact fulfilled the ticket requirements. Default is true.</td>
-  </tr>
-</table>
+    <table>
+      <tr>
+        <td><b>require_score_review</b></td>
+        <td>If set to true, the tool will add a section that scores the PR. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>require_tests_review</b></td>
+        <td>If set to true, the tool will add a section that checks if the PR contains tests. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>require_estimate_effort_to_review</b></td>
+        <td>If set to true, the tool will add a section that estimates the effort needed to review the PR. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>require_can_be_split_review</b></td>
+        <td>If set to true, the tool will add a section that checks if the PR contains several themes, and can be split into smaller PRs. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>require_security_review</b></td>
+        <td>If set to true, the tool will add a section that checks if the PR contains a possible security or vulnerability issue. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>require_ticket_analysis_review</b></td>
+        <td>If set to true, and the PR contains a GitHub or Jira ticket link, the tool will add a section that checks if the PR in fact fulfilled the ticket requirements. Default is true.</td>
+      </tr>
+    </table>
 
 !!! example "Adding PR labels"
 
-You can enable\disable the `review` tool to add specific labels to the PR:
+    You can enable\disable the `review` tool to add specific labels to the PR:
 
-<table>
-  <tr>
-    <td><b>enable_review_labels_security</b></td>
-    <td>If set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.</td>
-  </tr>
-  <tr>
-    <td><b>enable_review_labels_effort</b></td>
-    <td>If set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.</td>
-  </tr>
-</table>
+    <table>
+      <tr>
+        <td><b>enable_review_labels_security</b></td>
+        <td>If set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>enable_review_labels_effort</b></td>
+        <td>If set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.</td>
+      </tr>
+    </table>
 
 
 ## Usage Tips

From b4e2a325433d0ce040f55d55d75d691799d75098 Mon Sep 17 00:00:00 2001
From: ofir-frd <85901822+ofir-frd@users.noreply.github.com>
Date: Fri, 14 Mar 2025 12:04:58 +0200
Subject: [PATCH 2/2] Update describe.md

---
 docs/docs/tools/describe.md | 100 ++++++++++++++++++------------------
 1 file changed, 50 insertions(+), 50 deletions(-)

diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md
index d77a645e..0980923d 100644
--- a/docs/docs/tools/describe.md
+++ b/docs/docs/tools/describe.md
@@ -46,56 +46,56 @@ publish_labels = true
 
 !!! example "Possible configurations"
 
-<table>
-  <tr>
-    <td><b>publish_labels</b></td>
-    <td>If set to true, the tool will publish labels to the PR. Default is false.</td>
-  </tr>
-  <tr>
-    <td><b>publish_description_as_comment</b></td>
-    <td>If set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the original description. Default is false.</td>
-  </tr>
-  <tr>
-    <td><b>publish_description_as_comment_persistent</b></td>
-    <td>If set to true and `publish_description_as_comment` is true, the tool will publish the description as a persistent comment to the PR. Default is true.</td>
-  </tr>
-  <tr>
-    <td><b>add_original_user_description</b></td>
-    <td>If set to true, the tool will add the original user description to the generated description. Default is true.</td>
-  </tr>
-  <tr>
-    <td><b>generate_ai_title</b></td>
-    <td>If set to true, the tool will also generate an AI title for the PR. Default is false.</td>
-  </tr>
-  <tr>
-    <td><b>extra_instructions</b></td>
-    <td>Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ..."</td>
-  </tr>
-  <tr>
-    <td><b>enable_pr_type</b></td>
-    <td>If set to false, it will not show the `PR type` as a text value in the description content. Default is true.</td>
-  </tr>
-  <tr>
-    <td><b>final_update_message</b></td>
-    <td>If set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is false.</td>
-  </tr>
-  <tr>
-    <td><b>enable_semantic_files_types</b></td>
-    <td>If set to true, "Changes walkthrough" section will be generated. Default is true.</td>
-  </tr>
-  <tr>
-    <td><b>collapsible_file_list</b></td>
-    <td>If set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive".</td>
-  </tr>
-  <tr>
-    <td><b>enable_large_pr_handling</b></td>
-    <td>Pro feature. If set to true, in case of a large PR the tool will make several calls to the AI and combine them to be able to cover more files. Default is true.</td>
-  </tr>
-  <tr>
-    <td><b>enable_help_text</b></td>
-    <td>If set to true, the tool will display a help text in the comment. Default is false.</td>
-  </tr>
-</table>
+    <table>
+      <tr>
+        <td><b>publish_labels</b></td>
+        <td>If set to true, the tool will publish labels to the PR. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>publish_description_as_comment</b></td>
+        <td>If set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the original description. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>publish_description_as_comment_persistent</b></td>
+        <td>If set to true and `publish_description_as_comment` is true, the tool will publish the description as a persistent comment to the PR. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>add_original_user_description</b></td>
+        <td>If set to true, the tool will add the original user description to the generated description. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>generate_ai_title</b></td>
+        <td>If set to true, the tool will also generate an AI title for the PR. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>extra_instructions</b></td>
+        <td>Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ..."</td>
+      </tr>
+      <tr>
+        <td><b>enable_pr_type</b></td>
+        <td>If set to false, it will not show the `PR type` as a text value in the description content. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>final_update_message</b></td>
+        <td>If set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>enable_semantic_files_types</b></td>
+        <td>If set to true, "Changes walkthrough" section will be generated. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>collapsible_file_list</b></td>
+        <td>If set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive".</td>
+      </tr>
+      <tr>
+        <td><b>enable_large_pr_handling</b></td>
+        <td>Pro feature. If set to true, in case of a large PR the tool will make several calls to the AI and combine them to be able to cover more files. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>enable_help_text</b></td>
+        <td>If set to true, the tool will display a help text in the comment. Default is false.</td>
+      </tr>
+    </table>
 
 
 ## Inline file summary 💎