From ad4a96caf1b7220f81ef5f1bb9c2c2cd44f5cea5 Mon Sep 17 00:00:00 2001
From: mrT23 <tal.r@codium.ai>
Date: Sun, 19 Jan 2025 15:05:38 +0200
Subject: [PATCH] docs: add wiki setup guide and update best practices
 documentation

---
 docs/docs/tools/improve.md               |  2 +-
 docs/docs/usage-guide/enabling_a_wiki.md | 23 +++++++++++++++++++++++
 docs/docs/usage-guide/index.md           |  1 +
 docs/mkdocs.yml                          |  1 +
 4 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 docs/docs/usage-guide/enabling_a_wiki.md

diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md
index ba9a0695f..fd16a609f 100644
--- a/docs/docs/tools/improve.md
+++ b/docs/docs/tools/improve.md
@@ -122,7 +122,7 @@ Use triple quotes to write multi-line instructions. Use bullet points or numbers
 
 >`Platforms supported: GitHub, GitLab, Bitbucket`
 
-Another option to give additional guidance to the AI model is by creating a dedicated [**wiki page**](https://github.com/Codium-ai/pr-agent/wiki) called `best_practices.md`.
+Another option to give additional guidance to the AI model is by creating a `best_practices.md` file, either in your repository's root directory or as a [**wiki page**](https://github.com/Codium-ai/pr-agent/wiki) (we recommend the wiki page, as editing and maintaining it over time is easier).
 This page can contain a list of best practices, coding standards, and guidelines that are specific to your repo/organization.
 
 The AI model will use this wiki page as a reference, and in case the PR code violates any of the guidelines, it will create additional suggestions, with a dedicated label: `Organization
diff --git a/docs/docs/usage-guide/enabling_a_wiki.md b/docs/docs/usage-guide/enabling_a_wiki.md
new file mode 100644
index 000000000..be0dbec78
--- /dev/null
+++ b/docs/docs/usage-guide/enabling_a_wiki.md
@@ -0,0 +1,23 @@
+
+
+For optimal functionality of Qodo Merge, we recommend enabling a wiki for each repository where Qodo Merge is installed. The wiki serves several important purposes:
+
+**Key Wiki Features:**
+
+- Storing a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file)
+- Defining a [`best_practices.md`](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) file
+- Track [accepted suggestions](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking)
+- Facilitates learning over time by creating an [auto_best_practices.md]() file
+
+
+**Setup Instructions:**
+
+To enable a wiki for your repository:
+
+1. Navigate to your repository's main page on GitHub
+2. Select "Settings" from the top navigation bar
+3. Locate the "Features" section
+4. Enable the "Wikis" option by checking the corresponding box
+5. Return to your repository's main page
+6. Look for the newly added "Wiki" tab in the top navigation
+7. Initialize your wiki by clicking "Create the first page" (this step is important - without creating an initial page, the wiki will not be fully functional)
diff --git a/docs/docs/usage-guide/index.md b/docs/docs/usage-guide/index.md
index 1b680d8c0..567ba9f33 100644
--- a/docs/docs/usage-guide/index.md
+++ b/docs/docs/usage-guide/index.md
@@ -5,6 +5,7 @@ It includes information on how to adjust Qodo Merge configurations, define which
 
 
 - [Introduction](./introduction.md)
+- [Enabling a Wiki](./enabling_a_wiki)
 - [Configuration File](./configuration_options.md)
 - [Usage and Automation](./automations_and_usage.md)
     - [Local Repo (CLI)](./automations_and_usage.md#local-repo-cli)
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 9159197ed..2a4717a76 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -18,6 +18,7 @@ nav:
   - Usage Guide:
     - 'usage-guide/index.md'
     - Introduction: 'usage-guide/introduction.md'
+    - Enabling a Wiki: 'usage-guide/enabling_a_wiki.md'
     - Configuration File: 'usage-guide/configuration_options.md'
     - Usage and Automation: 'usage-guide/automations_and_usage.md'
     - Managing Mail Notifications: 'usage-guide/mail_notifications.md'