From e7bbc4ac0c72bb77c6b765be481ba1844d166d29 Mon Sep 17 00:00:00 2001
From: 0xrahul6 <113128186+0xrahul6@users.noreply.github.com>
Date: Thu, 19 Oct 2023 17:13:30 +0000
Subject: [PATCH] Enhanced Chatwoot-Extension

---
 docs/pages/Extensions/Chatwoot-extension.md | 64 +++++++++++----------
 1 file changed, 33 insertions(+), 31 deletions(-)

diff --git a/docs/pages/Extensions/Chatwoot-extension.md b/docs/pages/Extensions/Chatwoot-extension.md
index f9db022b4..d6494bbf8 100644
--- a/docs/pages/Extensions/Chatwoot-extension.md
+++ b/docs/pages/Extensions/Chatwoot-extension.md
@@ -1,42 +1,44 @@
-### To Start Chatwoot Extension:
+## Chatwoot Extension Setup Guide
 
-1. **Prepare and Start DocsGPT:**
-   - Launch DocsGPT using the instructions in our [wiki](https://github.com/arc53/DocsGPT/wiki).
-   - Make sure to load your documentation.
+### Step 1: Prepare and Start DocsGPT
 
-2. **Get Access Token from Chatwoot:**
-   - Navigate to Chatwoot.
-   - Go to your profile (bottom left), click on profile settings.
-   - Scroll to the bottom and copy the **Access Token**.
+- **Launch DocsGPT**: Follow the instructions in our [DocsGPT Wiki](https://github.com/arc53/DocsGPT/wiki) to start DocsGPT. Make sure to load your documentation.
 
-3. **Set Up Chatwoot Extension:**
-   - Navigate to `/extensions/chatwoot`.
-   - Copy `.env_sample` and create a `.env` file.
-   - Fill in the values in the `.env` file:
+### Step 2: Get Access Token from Chatwoot
 
-     ```env
-     docsgpt_url=<docsgpt_api_url>
-     chatwoot_url=<chatwoot_url>
-     docsgpt_key=<openai_api_key or other llm key>
-     chatwoot_token=<from part 2>
-     ```
+- Go to Chatwoot.
+- In your profile settings (located at the bottom left), scroll down and copy the **Access Token**.
 
-4. **Start the Extension:**
-   - Use the command `flask run` to start the extension.
+### Step 3: Set Up Chatwoot Extension
 
-5. **Optional: Extra Validation**
-   - In `app.py`, uncomment lines 12-13 and 71-75.
-   - Add the following lines to your `.env` file:
+- Navigate to `/extensions/chatwoot`.
+- Copy the `.env_sample` file and create a new file named `.env`.
+- Fill in the values in the `.env` file as follows:
 
-     ```env
-     account_id=(optional) 1
-     assignee_id=(optional) 1
-     ```
+```env
+docsgpt_url=<Docsgpt_API_URL>
+chatwoot_url=<Chatwoot_URL>
+docsgpt_key=<OpenAI_API_Key or Other_LLM_Key>
+chatwoot_token=<Token from Step 2>
+```
 
-     These Chatwoot values help ensure you respond to the correct widget and handle questions assigned to a specific user.
+### Step 4: Start the Extension
+
+- Use the command `flask run` to start the extension.
+
+### Step 5: Optional - Extra Validation
+
+- In app.py, uncomment lines 12-13 and 71-75.
+- Add the following lines to your .env file:
+```account_id=(optional) 1
+assignee_id=(optional) 1
+```
+These Chatwoot values help ensure you respond to the correct widget and handle questions assigned to a specific user.
+
+### Stopping Bot Responses for Specific User or Session
 
-### Stopping Bot Responses for Specific User or Session:
 - If you want the bot to stop responding to questions for a specific user or session, add a label `human-requested` in your conversation.
 
-### Additional Notes:
-- For further details on training on other documentation, refer to our [wiki](https://github.com/arc53/DocsGPT/wiki/How-to-train-on-other-documentation).
+### Additional Notes
+
+- For further details on training on other documentation, refer to our [wiki](https://github.com/arc53/DocsGPT/wiki/How-to-train-on-other-documentation).
\ No newline at end of file