From 796b36f0d1b6dbe2ed5cfd7968ad068877f35fe2 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Wed, 25 Dec 2024 11:34:41 +0200 Subject: [PATCH] Add documentation for /implement tool in tools section and related files --- docs/docs/tools/implement.md | 22 ++++++++++++++++++++++ docs/docs/tools/index.md | 2 +- docs/mkdocs.yml | 1 + 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 docs/docs/tools/implement.md diff --git a/docs/docs/tools/implement.md b/docs/docs/tools/implement.md new file mode 100644 index 000000000..529541ab8 --- /dev/null +++ b/docs/docs/tools/implement.md @@ -0,0 +1,22 @@ +## Overview + +The `implement` tool automatically generates implementation code based on PR review suggestions. +It combines LLM capabilities with static code analysis to help developers implement code changes quickly and with confidence. + + +To use the tool, manually invoke it by commenting in any PR discussion that contains code suggestions: +``` +/implement +``` + +## Example usage + +Invoke the tool manually by commenting `/implement` on any PR review discussion. +The tool will generate code implementation for the selected discussion: + +![implement1](https://codium.ai/images/pr_agent/implement1.png){width=768} + + +**Notes**
+- Languages that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript, C#.
+- Use `/implement ` to indirectly call the tool. \ No newline at end of file diff --git a/docs/docs/tools/index.md b/docs/docs/tools/index.md index 9b856e23d..4301c5b0a 100644 --- a/docs/docs/tools/index.md +++ b/docs/docs/tools/index.md @@ -18,5 +18,5 @@ Here is a list of Qodo Merge tools, each with a dedicated page that explains how | **💎 [Generate Tests (`/test component_name`](./test.md))** | Automatically generates unit tests for a selected component, based on the PR code changes | | **💎 [Improve Component (`/improve_component component_name`](./improve_component.md))** | Generates code suggestions for a specific code component that changed in the PR | | **💎 [CI Feedback (`/checks ci_job`](./ci_feedback.md))** | Automatically generates feedback and analysis for a failed CI job | - +| **💎 [Implement (`/implement`](./implement.md))** | Generates implementation code from review suggestions | Note that the tools marked with 💎 are available only for Qodo Merge Pro users. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b168f6215..9159197ed 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -41,6 +41,7 @@ nav: - 💎 Custom Prompt: 'tools/custom_prompt.md' - 💎 CI Feedback: 'tools/ci_feedback.md' - 💎 Similar Code: 'tools/similar_code.md' + - 💎 Implement: 'tools/implement.md' - Core Abilities: - 'core-abilities/index.md' - Fetching ticket context: 'core-abilities/fetching_ticket_context.md'