From ecd8cebbefea88cb09fc77ecd56bb6a68be5aa7d Mon Sep 17 00:00:00 2001
From: Rahul Kumar <104289350+rahul0x00@users.noreply.github.com>
Date: Sun, 15 Oct 2023 04:20:09 +0000
Subject: [PATCH 1/2] Quickstart: Enhanced Documentation for Launching DocsGPT
 and Installing Chrome Extension

---
 docs/pages/Deploying/Quickstart.md | 60 ++++++++++++++++++++++++++----
 1 file changed, 52 insertions(+), 8 deletions(-)

diff --git a/docs/pages/Deploying/Quickstart.md b/docs/pages/Deploying/Quickstart.md
index 5ed37a5..c8bd5a4 100644
--- a/docs/pages/Deploying/Quickstart.md
+++ b/docs/pages/Deploying/Quickstart.md
@@ -1,24 +1,68 @@
 ## Launching Web App
-Note: Make sure you have Docker installed
+**Note**: Make sure you have Docker installed
 
-On macOS or Linux, just write:
+**On macOS or Linux:**
+Just run the following command::
 
 `./setup.sh`
 
-It will install all the dependencies and give you an option to download the local model or use OpenAI
+This command will install all the necessary dependencies and provide you with an option to download the local model or use OpenAI.
 
-Otherwise, refer to this Guide:
+If you prefer to follow manual steps, refer to this guide:
 
-1. Open and download this repository with `git clone https://github.com/arc53/DocsGPT.git`.
+1. Open and download this repository with 
+`git clone https://github.com/arc53/DocsGPT.git`.
 2. Create a `.env` file in your root directory and set your `API_KEY` with your [OpenAI API key](https://platform.openai.com/account/api-keys).
-3. Run `docker-compose build && docker-compose up`.
+3. Run the following commands:
+`docker-compose build && docker-compose up`.
 4. Navigate to `http://localhost:5173/`.
 
-To stop, just run `Ctrl + C`.
+To stop, simply press Ctrl + C.
+
+For WINDOWS:
+
+To run the setup on Windows, you have two options: using the Windows Subsystem for Linux (WSL) or using Git Bash or Command Prompt.
+
+**Option 1: Using Windows Subsystem for Linux (WSL):**
+
+1. Install WSL if you haven't already. You can follow the official Microsoft documentation for installation: (https://learn.microsoft.com/en-us/windows/wsl/install).
+2. After setting up WSL, open the WSL terminal.
+3. Clone the repository and create the `.env` file:
+   ```
+   git clone https://github.com/arc53/DocsGPT.git
+   cd DocsGPT
+   echo "API_KEY=Yourkey" > .env
+   echo "VITE_API_STREAMING=true" >> .env
+   ```
+4. Run the following command to start the setup with Docker Compose:
+    `./run-with-docker-compose.sh`
+5. Open your web browser and navigate to (http://localhost:5173/).
+6. To stop the setup, just press `Ctrl + C` in the WSL terminal
+
+**Option 2: Using Git Bash or Command Prompt (CMD):**
+
+1. Install Git for Windows if you haven't already. Download it from the official website: (https://gitforwindows.org/).
+2. Open Git Bash or Command Prompt.
+3. Clone the repository and create the `.env` file:
+   ```
+   git clone https://github.com/arc53/DocsGPT.git
+   cd DocsGPT
+   echo "API_KEY=Yourkey" > .env
+   echo "VITE_API_STREAMING=true" >> .env
+   ```
+4.Run the following command to start the setup with Docker Compose:
+  `./run-with-docker-compose.sh`
+5.Open your web browser and navigate to (http://localhost:5173/).
+6.To stop the setup, just press Ctrl + C in the Git Bash or Command Prompt terminal.
+
+These steps should help you set up and run the project on Windows using either WSL or Git Bash/Command Prompt. 
+**Important:** Ensure that Docker is installed and properly configured on your Windows system for these steps to work.
+
 
 ### Chrome Extension
 
-To install the Chrome extension:
+#### Installing the Chrome extension:
+To enhance your DocsGPT experience, you can install the DocsGPT Chrome extension. Here's how:
 
 1. In the DocsGPT GitHub repository, click on the "Code" button and select "Download ZIP".
 2. Unzip the downloaded file to a location you can easily access.

From 832569a79cf1ab308047cf5f603fd17f8680075e Mon Sep 17 00:00:00 2001
From: Rahul Kumar <104289350+rahul0x00@users.noreply.github.com>
Date: Sun, 15 Oct 2023 09:54:25 +0530
Subject: [PATCH 2/2] Update Quickstart.md

---
 docs/pages/Deploying/Quickstart.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/pages/Deploying/Quickstart.md b/docs/pages/Deploying/Quickstart.md
index c8bd5a4..612c0b4 100644
--- a/docs/pages/Deploying/Quickstart.md
+++ b/docs/pages/Deploying/Quickstart.md
@@ -19,7 +19,7 @@ If you prefer to follow manual steps, refer to this guide:
 
 To stop, simply press Ctrl + C.
 
-For WINDOWS:
+**For WINDOWS:**
 
 To run the setup on Windows, you have two options: using the Windows Subsystem for Linux (WSL) or using Git Bash or Command Prompt.