Merge pull request Codium-ai#841 from Codium-ai/tr/readme

readme

docs/docs/index.md

@@ -84,16 +84,18 @@ Check out the [PR Compression strategy](core-abilities/index.md) page for more d
 2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
 3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
 4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional tools and features:
-    - [**Analyze PR components**](./tools/analyze.md/)
-    - [**Custom Code Suggestions**](./tools/custom_suggestions.md/)
-    - [**Tests**](./tools/test.md/)
-    - [**PR documentation**](./tools/documentation.md/)
-    - [**Improve Component**](https://pr-agent-docs.codium.ai/tools/improve_component/)
-    - [**Similar code search**](https://pr-agent-docs.codium.ai/tools/similar_code/)
-    - [**CI feedback**](./tools/ci_feedback.md/)
-    - [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance)
-    - [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page)
-    - [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file)
+    - (Tool): [**Analyze PR components**](./tools/analyze.md/)
+    - (Tool): [**Custom Code Suggestions**](./tools/custom_suggestions.md/)
+    - (Tool): [**Tests**](./tools/test.md/)
+    - (Tool): [**PR documentation**](./tools/documentation.md/)
+    - (Tool): [**Improve Component**](https://pr-agent-docs.codium.ai/tools/improve_component/)
+    - (Tool): [**Similar code search**](https://pr-agent-docs.codium.ai/tools/similar_code/)
+    - (Tool): [**CI feedback**](./tools/ci_feedback.md/)
+    - (Feature): [**Interactive triggering**](./usage-guide/automations_and_usage.md/#interactive-triggering)
+    - (Feature): [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance)
+    - (Feature): [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page)
+    - (Feature): [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file)
+    - (Feature): [**Inline file summary**](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary)
 
 
 ## Data Privacy

docs/docs/tools/analyze.md

@@ -1,21 +1,17 @@
 ## Overview
-The `analyze` tool combines static code analysis with LLM capabilities to provide a comprehensive analysis of the PR code changes.
+The `analyze` tool combines advanced static code analysis with LLM capabilities to provide a comprehensive analysis of the PR code changes.
 
-The tool scans the PR code changes, find the code components (methods, functions, classes) that changed, and summarizes the changes in each component.
+The tool scans the PR code changes, find the code components (methods, functions, classes) that changed, and enables to interactively generate tests, docs, code suggestions and similar code search for each component.
 
 It can be invoked manually by commenting on any PR:
 ```
 /analyze
 ```
 
 ## Example usage
-An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
+An example result:
 
 ![Analyze 1](https://codium.ai/images/pr_agent/analyze_1.png){width=750}
-→
-![Analyze 2](https://codium.ai/images/pr_agent/analyze_2.png){width=750}
-→
-![Analyze 3](https://codium.ai/images/pr_agent/analyze_3.png){width=750}
 
 **Notes**
 

docs/docs/tools/help.md

@@ -0,0 +1,13 @@
+## Overview
+The `help` tool provides a list of all the available tools and their descriptions.
+For PR-Agent Pro users, it also enables to trigger each tool by checking the relevant box.
+```
+/help
+```
+
+## Example usage
+An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
+
+![Help 1](https://codium.ai/images/pr_agent/help1.png){width=750}
+→
+![Analyze 2](https://codium.ai/images/pr_agent/help2.png){width=750}

docs/docs/tools/index.md

@@ -10,6 +10,7 @@ Here is a list of PR-Agent tools, each with a dedicated page that explains how t
 | **[Question Answering (`/ask ...`](./ask.md))**                                          | Answering free-text questions about the PR, or on specific code lines                                                                       |
 | **[Update Changelog (`/update_changelog`](./update_changelog.md))**                      | Automatically updating the CHANGELOG.md file with the PR changes                                                                            |
 | **[Find Similar Issue (`/similar_issue`](./similar_issues.md))**                         | Automatically retrieves and presents similar issues                                                                                         |
+| **[Help (`/help`](./help.md))**                                                         | Provides a list of all the available tools. Also enables to trigger them interactively (💎)                                                 |
 | **💎 [Add Documentation (`/add_docs`](./documentation.md))**                             | Generates documentation to methods/functions/classes that changed in the PR                                                                 |
 | **💎 [Generate Custom Labels (`/generate_labels`](./custom_labels.md))**                 | Generates custom labels for the PR, based on specific guidelines defined by the user                                                        |
 | **💎 [Analyze (`/analyze`](./analyze.md))**                                              | Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component |

docs/docs/usage-guide/index.md

@@ -1,8 +1,10 @@
 # Usage guide
 
+This page provides a detailed guide on how to use PR-Agent. It includes information on how to adjust PR-Agent configurations, define which tools will run automatically, manage mail notifications, and other advanced configurations.
+
+
 - [Introduction](./introduction.md)
 - [Configuration Options](./configuration_options.md)
-- [Managing Mail Notifications](./mail_notifications.md)
 - [Usage and Automation](./automations_and_usage.md)
     - [Local Repo (CLI)](./automations_and_usage.md#local-repo-cli)
     - [Online Usage](./automations_and_usage.md#online-usage)
@@ -11,6 +13,7 @@
     - [GitLab Webhook](./automations_and_usage.md#gitlab-webhook)
     - [BitBucket App](./automations_and_usage.md#bitbucket-app)
     - [Azure DevOps Provider](./automations_and_usage.md#azure-devops-provider)
+- [Managing Mail Notifications](./mail_notifications.md)
 - [Additional Configurations Walkthrough](./additional_configurations.md)
     - [Ignoring files from analysis](./additional_configurations.md#ignoring-files-from-analysis)
     - [Extra instructions](./additional_configurations.md#extra-instructions)