+
### Jan 1, 2025
diff --git a/docs/docs/core-abilities/metadata.md b/docs/docs/core-abilities/metadata.md
index c1eb04c0..b886929e 100644
--- a/docs/docs/core-abilities/metadata.md
+++ b/docs/docs/core-abilities/metadata.md
@@ -1,5 +1,5 @@
## Local and global metadata injection with multi-stage analysis
-(1)
+1\.
Qodo Merge initially retrieves for each PR the following data:
- PR title and branch name
@@ -11,7 +11,7 @@ Qodo Merge initially retrieves for each PR the following data:
!!! tip "Tip: Organization-level metadata"
In addition to the inputs above, Qodo Merge can incorporate supplementary preferences provided by the user, like [`extra_instructions` and `organization best practices`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices). This information can be used to enhance the PR analysis.
-(2)
+2\.
By default, the first command that Qodo Merge executes is [`describe`](https://qodo-merge-docs.qodo.ai/tools/describe/), which generates three types of outputs:
- PR Type (e.g. bug fix, feature, refactor, etc)
@@ -49,8 +49,8 @@ __old hunk__
...
```
-(3) The entire PR files that were retrieved are also used to expand and enhance the PR context (see [Dynamic Context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)).
+3\. The entire PR files that were retrieved are also used to expand and enhance the PR context (see [Dynamic Context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)).
-(4) All the metadata described above represents several level of cumulative analysis - ranging from hunk level, to file level, to PR level, to organization level.
+4\. All the metadata described above represents several level of cumulative analysis - ranging from hunk level, to file level, to PR level, to organization level.
This comprehensive approach enables Qodo Merge AI models to generate more precise and contextually relevant suggestions and feedback.
diff --git a/docs/docs/tools/analyze.md b/docs/docs/tools/analyze.md
index c23d4418..189c20af 100644
--- a/docs/docs/tools/analyze.md
+++ b/docs/docs/tools/analyze.md
@@ -14,6 +14,5 @@ An example result:
{width=750}
-**Notes**
-
-- Language that are currently supported: Python, Java, C++, JavaScript, TypeScript, C#.
+!!! note "Language that are currently supported:"
+ Python, Java, C++, JavaScript, TypeScript, C#.
diff --git a/docs/docs/tools/ask.md b/docs/docs/tools/ask.md
index d29d0319..7a5dad6f 100644
--- a/docs/docs/tools/ask.md
+++ b/docs/docs/tools/ask.md
@@ -38,20 +38,20 @@ where `https://real_link_to_image` is the direct link to the image.
Note that GitHub has a built-in mechanism of pasting images in comments. However, pasted image does not provide a direct link.
To get a direct link to an image, we recommend using the following scheme:
-1) First, post a comment that contains **only** the image:
+1\. First, post a comment that contains **only** the image:
{width=512}
-2) Quote reply to that comment:
+2\. Quote reply to that comment:
{width=512}
-3) In the screen opened, type the question below the image:
+3\. In the screen opened, type the question below the image:
{width=512}
{width=512}
-4) Post the comment, and receive the answer:
+4\. Post the comment, and receive the answer:
{width=512}
diff --git a/docs/docs/tools/custom_prompt.md b/docs/docs/tools/custom_prompt.md
index 9ec01fd9..7b31a5a5 100644
--- a/docs/docs/tools/custom_prompt.md
+++ b/docs/docs/tools/custom_prompt.md
@@ -51,8 +51,8 @@ Results obtained with the prompt above:
## Configuration options
-`prompt`: the prompt for the tool. It should be a multi-line string.
+- `prompt`: the prompt for the tool. It should be a multi-line string.
-`num_code_suggestions_per_chunk`: number of code suggestions provided by the 'custom_prompt' tool, per chunk. Default is 4.
+- `num_code_suggestions_per_chunk`: number of code suggestions provided by the 'custom_prompt' tool, per chunk. Default is 4.
-`enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.
+- `enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.
diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md
index 6e8515b0..d77a645e 100644
--- a/docs/docs/tools/describe.md
+++ b/docs/docs/tools/describe.md
@@ -143,7 +143,7 @@ The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary`
{width=512}
-→
+becomes
{width=512}
diff --git a/docs/docs/tools/documentation.md b/docs/docs/tools/documentation.md
index 12832b8d..b09eda3e 100644
--- a/docs/docs/tools/documentation.md
+++ b/docs/docs/tools/documentation.md
@@ -27,7 +27,6 @@ You can state a name of a specific component in the PR to get documentation only
- `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.
- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
-**Notes**
-
-- Language that are currently fully supported: Python, Java, C++, JavaScript, TypeScript, C#.
-- This tool can also be triggered interactively by using the [`analyze`](./analyze.md) tool.
+!!! note "Notes"
+ - The following languages are currently supported: Python, Java, C++, JavaScript, TypeScript, C#.
+ - This tool can also be triggered interactively by using the [`analyze`](./analyze.md) tool.
diff --git a/docs/docs/tools/implement.md b/docs/docs/tools/implement.md
index 3ee1b94b..4151fde7 100644
--- a/docs/docs/tools/implement.md
+++ b/docs/docs/tools/implement.md
@@ -10,8 +10,9 @@ It leverages LLM technology to transform PR comments and review suggestions into
### For Reviewers
-Reviewers can request code changes by: | enable_auto_approval | -If set to true, the tool will approve the PR when invoked with the 'auto_approve' command. Default is false. This flag can be changed only from a configuration file. | -