From 7e8fb388a322a29b47a68de304ad6cf5fcd1eb0a Mon Sep 17 00:00:00 2001 From: Guspan Tanadi <36249910+guspan-tanadi@users.noreply.github.com> Date: Mon, 13 Nov 2023 19:17:13 +0700 Subject: [PATCH 1/6] style(README): highlight markdown available Note section --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 58639d3d..01af9c62 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,8 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize ## QuickStart -Note: Make sure you have [Docker](https://docs.docker.com/engine/install/) installed +> [!Note] +> Make sure you have [Docker](https://docs.docker.com/engine/install/) installed On Mac OS or Linux, write: @@ -118,7 +119,8 @@ docker compose -f docker-compose-dev.yaml up -d ### Run the Backend -Make sure you have Python 3.10 or 3.11 installed. +> [!Note] +> Make sure you have Python 3.10 or 3.11 installed. 1. Export required environment variables or prepare a `.env` file in the `/application` folder: - Copy [.env_sample](https://github.com/arc53/DocsGPT/blob/main/application/.env_sample) and create `.env` with your OpenAI API token for the `API_KEY` and `EMBEDDINGS_KEY` fields. @@ -153,7 +155,8 @@ pip install -r requirements.txt ### Start Frontend -Make sure you have Node version 16 or higher. +> [!Note] +> Make sure you have Node version 16 or higher. 1. Navigate to the [/frontend](https://github.com/arc53/DocsGPT/tree/main/frontend) folder. 2. Install the required packages `husky` and `vite` (ignore if already installed). From 1f0ce88e0872142a52a691704a9b3384f452c0c4 Mon Sep 17 00:00:00 2001 From: Guspan Tanadi <36249910+guspan-tanadi@users.noreply.github.com> Date: Mon, 13 Nov 2023 19:33:01 +0700 Subject: [PATCH 2/6] style: highlight markdown Note Important section Quickstart --- docs/pages/Deploying/Quickstart.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/pages/Deploying/Quickstart.md b/docs/pages/Deploying/Quickstart.md index cb5fcf38..8fe86628 100644 --- a/docs/pages/Deploying/Quickstart.md +++ b/docs/pages/Deploying/Quickstart.md @@ -1,5 +1,6 @@ ## Launching Web App -**Note**: Make sure you have Docker installed +> [!Note] +> Make sure you have Docker installed **On macOS or Linux:** Just run the following command: @@ -65,8 +66,9 @@ To run the setup on Windows, you have two options: using the Windows Subsystem f 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. +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. For WINDOWS: From 252e06bee69a48db07e0db4ba00c157ca4d37b00 Mon Sep 17 00:00:00 2001 From: Guspan Tanadi <36249910+guspan-tanadi@users.noreply.github.com> Date: Mon, 13 Nov 2023 19:54:12 +0700 Subject: [PATCH 3/6] revert markdown highlight Note Important section Quickstart --- docs/pages/Deploying/Quickstart.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/pages/Deploying/Quickstart.md b/docs/pages/Deploying/Quickstart.md index 8fe86628..438beb19 100644 --- a/docs/pages/Deploying/Quickstart.md +++ b/docs/pages/Deploying/Quickstart.md @@ -1,6 +1,5 @@ ## Launching Web App -> [!Note] -> Make sure you have Docker installed +**Note**: Make sure you have Docker installed **On macOS or Linux:** Just run the following command: @@ -66,9 +65,7 @@ To run the setup on Windows, you have two options: using the Windows Subsystem f 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. +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. For WINDOWS: From ee62b2cf31856bdf1d88ce55913889cbb9be50d6 Mon Sep 17 00:00:00 2001 From: Guspan Tanadi <36249910+guspan-tanadi@users.noreply.github.com> Date: Mon, 13 Nov 2023 19:56:23 +0700 Subject: [PATCH 4/6] lowercase Important section Quickstart --- 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 438beb19..135b2baa 100644 --- a/docs/pages/Deploying/Quickstart.md +++ b/docs/pages/Deploying/Quickstart.md @@ -65,7 +65,7 @@ To run the setup on Windows, you have two options: using the Windows Subsystem f 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. +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. For WINDOWS: From c2dea6b881c248d07b5558c1630aded56df7320c Mon Sep 17 00:00:00 2001 From: Guspan Tanadi <36249910+guspan-tanadi@users.noreply.github.com> Date: Mon, 13 Nov 2023 19:58:35 +0700 Subject: [PATCH 5/6] bold colon Important section Quickstart --- 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 135b2baa..edd0d07f 100644 --- a/docs/pages/Deploying/Quickstart.md +++ b/docs/pages/Deploying/Quickstart.md @@ -65,7 +65,7 @@ To run the setup on Windows, you have two options: using the Windows Subsystem f 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. +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. For WINDOWS: From e67ced88485ab33042f64a8f4d2faab6618755d3 Mon Sep 17 00:00:00 2001 From: Guspan Tanadi <36249910+guspan-tanadi@users.noreply.github.com> Date: Mon, 13 Nov 2023 20:02:07 +0700 Subject: [PATCH 6/6] new line Important section Quickstart --- docs/pages/Deploying/Quickstart.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/pages/Deploying/Quickstart.md b/docs/pages/Deploying/Quickstart.md index edd0d07f..cb5fcf38 100644 --- a/docs/pages/Deploying/Quickstart.md +++ b/docs/pages/Deploying/Quickstart.md @@ -65,7 +65,8 @@ To run the setup on Windows, you have two options: using the Windows Subsystem f 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. +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. For WINDOWS: