From 0f8deddcdfac92913ac6a9682d16396e8b0a7692 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Tue, 23 Jan 2024 00:27:13 +0900
Subject: [PATCH 01/20] docs: add requirements to installation guides

---
 docs/docs/guides/02-installation/01-mac.md    |  4 ++++
 .../docs/guides/02-installation/02-windows.md | 21 ++++++++++---------
 docs/docs/guides/02-installation/03-linux.md  | 17 +++++++++++++--
 3 files changed, 30 insertions(+), 12 deletions(-)

diff --git a/docs/docs/guides/02-installation/01-mac.md b/docs/docs/guides/02-installation/01-mac.md
index 8e67b5bed..a719cd913 100644
--- a/docs/docs/guides/02-installation/01-mac.md
+++ b/docs/docs/guides/02-installation/01-mac.md
@@ -17,6 +17,10 @@ keywords:
 
 # Installing Jan on MacOS
 
+## Requirements
+
+Ensure that your MacOS version is 13 or higher to run Jan.
+
 ## Installation
 
 Jan is available for download via our homepage, [https://jan.ai/](https://jan.ai/).
diff --git a/docs/docs/guides/02-installation/02-windows.md b/docs/docs/guides/02-installation/02-windows.md
index b200554d2..6623fba62 100644
--- a/docs/docs/guides/02-installation/02-windows.md
+++ b/docs/docs/guides/02-installation/02-windows.md
@@ -17,6 +17,17 @@ keywords:
 
 # Installing Jan on Windows
 
+## System Requirements
+
+Ensure that your system meets the following requirements:
+
+- Windows 10 or higher is required to run Jan.
+
+To enable GPU support, you will need:
+
+- NVIDIA GPU with CUDA Toolkit 11.7 or higher
+- NVIDIA driver 470.63.01 or higher
+
 ## Installation
 
 Jan is available for download via our homepage, [https://jan.ai](https://jan.ai/).
@@ -59,13 +70,3 @@ To remove all user data associated with Jan, you can delete the `/jan` directory
 cd C:\Users\%USERNAME%\AppData\Roaming
 rmdir /S jan
 ```
-
-## Troubleshooting
-
-### Microsoft Defender
-
-**Error: "Microsoft Defender SmartScreen prevented an unrecognized app from starting"**
-
-Windows Defender may display the above warning when running the Jan Installer, as a standard security measure.
-
-To proceed, select the "More info" option and select the "Run Anyway" option to continue with the installation.
diff --git a/docs/docs/guides/02-installation/03-linux.md b/docs/docs/guides/02-installation/03-linux.md
index 21dfac1a9..bb93a8a3b 100644
--- a/docs/docs/guides/02-installation/03-linux.md
+++ b/docs/docs/guides/02-installation/03-linux.md
@@ -17,6 +17,18 @@ keywords:
 
 # Installing Jan on Linux
 
+## Requirements
+
+Ensure that your system meets the following requirements:
+
+- glibc 2.27 or higher (check with `ldd --version`)
+- gcc 11, g++ 11, cpp 11, or higher, refer to this [link](https://jan.ai/guides/troubleshooting/gpu-not-used/#specific-requirements-for-linux) for more information.
+
+To enable GPU support, you will need:
+
+- NVIDIA GPU with CUDA Toolkit 11.7 or higher
+- NVIDIA driver 470.63.01 or higher
+
 ## Installation
 
 Jan is available for download via our homepage, [https://jan.ai](https://jan.ai/).
@@ -66,7 +78,8 @@ jan-linux-amd64-{version}.deb
 # AppImage
 jan-linux-x86_64-{version}.AppImage
 ```
-```
+
+````
 
 ## Uninstall Jan
 
@@ -75,7 +88,7 @@ To uninstall Jan on Linux, you should use your package manager's uninstall or re
 ```bash
 sudo apt-get remove jan
 # where jan is the name of Jan package
-```
+````
 
 For other Linux distributions, if you installed Jan via the `.AppImage` file, you can uninstall Jan by deleting the `.AppImage` file.
 

From cef149a11b3cd29c4285793b2e02ca60dfb47894 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Tue, 23 Jan 2024 00:33:18 +0900
Subject: [PATCH 02/20] docs: finalize installation guide

---
 docs/docs/guides/02-installation/01-mac.md     | 3 ++-
 docs/docs/guides/02-installation/02-windows.md | 1 +
 docs/docs/guides/02-installation/03-linux.md   | 7 +++----
 3 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/docs/docs/guides/02-installation/01-mac.md b/docs/docs/guides/02-installation/01-mac.md
index a719cd913..7a3961384 100644
--- a/docs/docs/guides/02-installation/01-mac.md
+++ b/docs/docs/guides/02-installation/01-mac.md
@@ -12,12 +12,13 @@ keywords:
     conversational AI,
     no-subscription fee,
     large language model,
+    installation guide,
   ]
 ---
 
 # Installing Jan on MacOS
 
-## Requirements
+## System Requirements
 
 Ensure that your MacOS version is 13 or higher to run Jan.
 
diff --git a/docs/docs/guides/02-installation/02-windows.md b/docs/docs/guides/02-installation/02-windows.md
index 6623fba62..d60ab86f7 100644
--- a/docs/docs/guides/02-installation/02-windows.md
+++ b/docs/docs/guides/02-installation/02-windows.md
@@ -12,6 +12,7 @@ keywords:
     conversational AI,
     no-subscription fee,
     large language model,
+    installation guide,
   ]
 ---
 
diff --git a/docs/docs/guides/02-installation/03-linux.md b/docs/docs/guides/02-installation/03-linux.md
index bb93a8a3b..0ec7fea60 100644
--- a/docs/docs/guides/02-installation/03-linux.md
+++ b/docs/docs/guides/02-installation/03-linux.md
@@ -12,12 +12,13 @@ keywords:
     conversational AI,
     no-subscription fee,
     large language model,
+    installation guide,
   ]
 ---
 
 # Installing Jan on Linux
 
-## Requirements
+## System Requirements
 
 Ensure that your system meets the following requirements:
 
@@ -79,8 +80,6 @@ jan-linux-amd64-{version}.deb
 jan-linux-x86_64-{version}.AppImage
 ```
 
-````
-
 ## Uninstall Jan
 
 To uninstall Jan on Linux, you should use your package manager's uninstall or remove option. For Debian/Ubuntu-based distributions, if you installed Jan via the `.deb` package, you can uninstall Jan using the following command:
@@ -88,7 +87,7 @@ To uninstall Jan on Linux, you should use your package manager's uninstall or re
 ```bash
 sudo apt-get remove jan
 # where jan is the name of Jan package
-````
+```
 
 For other Linux distributions, if you installed Jan via the `.AppImage` file, you can uninstall Jan by deleting the `.AppImage` file.
 

From f23e9115fc5cce5e2a85e2bbc5b5392bad876f84 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Tue, 23 Jan 2024 01:22:36 +0900
Subject: [PATCH 03/20] docs: add developer/install-and-prerequisites

---
 .../04-install-and-prerequisites.md           | 65 +++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 docs/docs/developer/01-overview/04-install-and-prerequisites.md

diff --git a/docs/docs/developer/01-overview/04-install-and-prerequisites.md b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
new file mode 100644
index 000000000..dbc39fccd
--- /dev/null
+++ b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
@@ -0,0 +1,65 @@
+---
+title: Installation and Prerequisites
+slug: /developer/install-and-prerequisites
+description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
+keywords:
+  [
+    Jan AI,
+    Jan,
+    ChatGPT alternative,
+    local AI,
+    private AI,
+    conversational AI,
+    no-subscription fee,
+    large language model,
+    installation,
+    prerequisites,
+    developer setup,
+  ]
+---
+
+## Requirements:
+
+- [Hardware Requirements](../../guides/02-installation/06-hardware.md)
+
+- System Requirements:
+  - [Windows](../../install/windows/#system-requirements)
+  - [MacOS](../../install/mac/#system-requirements)
+  - [Linux](../../install/linux/#system-requirements)
+
+## Prerequisites
+
+Before installing Jan, make sure you have the following installed on your computer:
+
+- [Node.js](https://nodejs.org/en/) (version 20.0.0 or higher)
+- [yarn](https://yarnpkg.com/) (version 1.22.0 or higher)
+- [make](https://www.gnu.org/software/make/) (version 3.81 or higher)
+
+## Instructions
+
+1. Clone the repository and install dependencies
+
+```bash
+git clone https://github.com/janhq/jan
+cd jan
+git checkout -b DESIRED_BRANCH
+yarn install
+```
+
+2. Run development and use Jan Desktop
+
+```bash
+make dev
+```
+
+This will start the development server and open the Jan Desktop app.
+
+## For Production Build
+
+```bash
+# Do steps 1 and 2 in the previous section
+# Build the app
+make build
+```
+
+This will build the app MacOS (M1/M2/M3) for production (with code signing already done) and put the result in dist folder.

From 7c0c6924d831bf6d070e8aa749ec8607dfeca6b9 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Tue, 23 Jan 2024 02:28:37 +0900
Subject: [PATCH 04/20] docs: finalize-installation-and-prerequisites

---
 .../01-overview/04-install-and-prerequisites.md     | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/docs/docs/developer/01-overview/04-install-and-prerequisites.md b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
index dbc39fccd..a5f7c985b 100644
--- a/docs/docs/developer/01-overview/04-install-and-prerequisites.md
+++ b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
@@ -18,7 +18,7 @@ keywords:
   ]
 ---
 
-## Requirements:
+## Requirements
 
 - [Hardware Requirements](../../guides/02-installation/06-hardware.md)
 
@@ -29,8 +29,6 @@ keywords:
 
 ## Prerequisites
 
-Before installing Jan, make sure you have the following installed on your computer:
-
 - [Node.js](https://nodejs.org/en/) (version 20.0.0 or higher)
 - [yarn](https://yarnpkg.com/) (version 1.22.0 or higher)
 - [make](https://www.gnu.org/software/make/) (version 3.81 or higher)
@@ -43,10 +41,15 @@ Before installing Jan, make sure you have the following installed on your comput
 git clone https://github.com/janhq/jan
 cd jan
 git checkout -b DESIRED_BRANCH
+```
+
+2. Install dependencies
+
+```bash
 yarn install
 ```
 
-2. Run development and use Jan Desktop
+3. Run development and use Jan Desktop
 
 ```bash
 make dev
@@ -62,4 +65,4 @@ This will start the development server and open the Jan Desktop app.
 make build
 ```
 
-This will build the app MacOS (M1/M2/M3) for production (with code signing already done) and put the result in dist folder.
+This will build the app MacOS (M1/M2/M3) for production (with code signing already done) and put the result in `dist` folder.

From b14ff4cdb5fa35fa565397a5f8698c40d8bba24d Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Tue, 23 Jan 2024 03:00:51 +0900
Subject: [PATCH 05/20] docs: finalize install and prerequisitites

---
 .../01-overview/04-install-and-prerequisites.md    | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/docs/docs/developer/01-overview/04-install-and-prerequisites.md b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
index a5f7c985b..b418609f6 100644
--- a/docs/docs/developer/01-overview/04-install-and-prerequisites.md
+++ b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
@@ -35,7 +35,7 @@ keywords:
 
 ## Instructions
 
-1. Clone the repository and install dependencies
+1. **Clone the Repository:**
 
 ```bash
 git clone https://github.com/janhq/jan
@@ -43,19 +43,19 @@ cd jan
 git checkout -b DESIRED_BRANCH
 ```
 
-2. Install dependencies
+2. **Install Dependencie:s**
 
 ```bash
 yarn install
 ```
 
-3. Run development and use Jan Desktop
+3. **Run Development and Use Jan Desktop**
 
 ```bash
 make dev
 ```
 
-This will start the development server and open the Jan Desktop app.
+This command starts the development server and opens the Jan Desktop app.
 
 ## For Production Build
 
@@ -65,4 +65,8 @@ This will start the development server and open the Jan Desktop app.
 make build
 ```
 
-This will build the app MacOS (M1/M2/M3) for production (with code signing already done) and put the result in `dist` folder.
+This will build the app MacOS (M1/M2/M3) for production (with code signing already done) and place the result in `/electron/dist` folder.
+
+## Troubleshooting
+
+If you run into any issues due to a broken build, please check the [Stuck on a Broken Build](../../troubleshooting/stuck-on-broken-build) guide.

From b946c5d3e029c88840c445930875b300989a00e7 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Tue, 23 Jan 2024 03:05:48 +0900
Subject: [PATCH 06/20] docs: correct slug

---
 .../developer/01-overview/04-install-and-prerequisites.md     | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/docs/developer/01-overview/04-install-and-prerequisites.md b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
index b418609f6..25fe2550e 100644
--- a/docs/docs/developer/01-overview/04-install-and-prerequisites.md
+++ b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
@@ -1,7 +1,7 @@
 ---
 title: Installation and Prerequisites
-slug: /developer/install-and-prerequisites
-description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
+slug: /developer/prereq
+description: Guide to install and setup Jan for development.
 keywords:
   [
     Jan AI,

From 0afdee4a9856d419499c74099b7dbe986d941c8b Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Wed, 24 Jan 2024 01:40:08 +0900
Subject: [PATCH 07/20] docs: update API Reference page

---
 docs/openapi/jan.yaml          |  55 +++--
 docs/openapi/specs/models.yaml | 370 ++++++++++-----------------------
 2 files changed, 150 insertions(+), 275 deletions(-)

diff --git a/docs/openapi/jan.yaml b/docs/openapi/jan.yaml
index bfff0ad73..9981f7308 100644
--- a/docs/openapi/jan.yaml
+++ b/docs/openapi/jan.yaml
@@ -67,21 +67,32 @@ paths:
       x-codeSamples:
         - lang: cURL
           source: |
-            curl http://localhost:1337/v1/chat/completions \
-              -H "Content-Type: application/json" \
+            curl -X 'POST' \
+              'http://127.0.0.1:1337/v1/chat/completions' \
+              -H 'accept: application/json' \
+              -H 'Content-Type: application/json' \
               -d '{
-                "model": "tinyllama-1.1b",
-                "messages": [
-                  {
-                    "role": "system",
-                    "content": "You are a helpful assistant."
-                  },
-                  {
-                    "role": "user",
-                    "content": "Hello!"
-                  }
-                ]
-              }'
+              "messages": [
+                {
+                  "content": "You are a helpful assistant.",
+                  "role": "system"
+                },
+                {
+                  "content": "Hello!",
+                  "role": "user"
+                }
+              ],
+              "model": "tinyllama-1.1b",
+              "stream": true,
+              "max_tokens": 2048,
+              "stop": [
+                "hello"
+              ],
+              "frequency_penalty": 0,
+              "presence_penalty": 0,
+              "temperature": 0.7,
+              "top_p": 0.95
+            }'
   /models:
     get:
       operationId: listModels
@@ -103,7 +114,9 @@ paths:
       x-codeSamples:
         - lang: cURL
           source: |
-            curl http://localhost:1337/v1/models
+            curl -X 'GET' \
+              'http://127.0.0.1:1337/v1/models' \
+              -H 'accept: application/json'
   "/models/download/{model_id}":
     get:
       operationId: downloadModel
@@ -131,7 +144,9 @@ paths:
       x-codeSamples:
         - lang: cURL
           source: |
-            curl -X POST http://localhost:1337/v1/models/download/{model_id}
+            curl -X 'GET' \
+              'http://127.0.0.1:1337/v1/models/download/{model_id}' \
+              -H 'accept: application/json'
   "/models/{model_id}":
     get:
       operationId: retrieveModel
@@ -162,7 +177,9 @@ paths:
       x-codeSamples:
         - lang: cURL
           source: |
-            curl http://localhost:1337/v1/models/{model_id}
+            curl -X 'GET' \
+              'http://127.0.0.1:1337/v1/models/{model_id}' \
+              -H 'accept: application/json'
     delete:
       operationId: deleteModel
       tags:
@@ -191,7 +208,9 @@ paths:
       x-codeSamples:
         - lang: cURL
           source: |
-            curl -X DELETE http://localhost:1337/v1/models/{model_id}
+            curl -X 'DELETE' \
+              'http://127.0.0.1:1337/v1/models/{model_id}' \
+              -H 'accept: application/json'
   /threads:
     post:
       operationId: createThread
diff --git a/docs/openapi/specs/models.yaml b/docs/openapi/specs/models.yaml
index 418be9563..791d14880 100644
--- a/docs/openapi/specs/models.yaml
+++ b/docs/openapi/specs/models.yaml
@@ -18,106 +18,77 @@ components:
     Model:
       type: object
       properties:
-        type:
-          type: string
-          default: model
-          description: The type of the object.
-        version:
-          type: string
-          default: "1"
-          description: The version number of the model.
-        id:
-          type: string
-          description: Unique identifier used in chat-completions model_name, matches
-            folder name.
-          example: zephyr-7b
-        name:
-          type: string
-          description: Name of the model.
-          example: Zephyr 7B
-        owned_by:
-          type: string
-          description: Compatibility field for OpenAI.
-          default: ""
-        created:
-          type: integer
-          format: int64
-          description: Unix timestamp representing the creation time.
-        description:
-          type: string
-          description: Description of the model.
-        state:
-          type: string
-          enum:
-            - null
-            - downloading
-            - ready
-            - starting
-            - stopping
-          description: Current state of the model.
-        format:
-          type: string
-          description: State format of the model, distinct from the engine.
-          example: ggufv3
         source_url:
           type: string
           format: uri
           description: URL to the source of the model.
-          example: https://huggingface.co/TheBloke/zephyr-7B-beta-GGUF/blob/main/zephyr-7b-beta.Q4_K_M.gguf
+          example: https://huggingface.co/janhq/trinity-v1.2-GGUF/resolve/main/trinity-v1.2.Q4_K_M.gguf
+        id:
+          type: string
+          description:
+            Unique identifier used in chat-completions model_name, matches
+            folder name.
+          example: trinity-v1.2-7b
+        object:
+          type: string
+          example: model
+        name:
+          type: string
+          description: Name of the model.
+          example: Trinity-v1.2 7B Q4
+        version:
+          type: string
+          default: "1.0"
+          description: The version number of the model.
+        description:
+          type: string
+          description: Description of the model.
+          example: Trinity is an experimental model merge using the Slerp method. Recommended for daily assistance purposes.
+        format:
+          type: string
+          description: State format of the model, distinct from the engine.
+          example: gguf
         settings:
           type: object
           properties:
             ctx_len:
-              type: string
+              type: integer
               description: Context length.
-              example: "2048"
-            ngl:
+              example: 4096
+            prompt_template:
               type: string
-              description: Number of layers.
-              example: "100"
-            embedding:
-              type: string
-              description: Indicates if embedding is enabled.
-              example: "true"
-            n_parallel:
-              type: string
-              description: Number of parallel processes.
-              example: "4"
+              example: "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant"
           additionalProperties: false
         parameters:
           type: object
           properties:
             temperature:
-              type: string
-              description: Temperature setting for the model.
-              example: "0.7"
-            token_limit:
-              type: string
-              description: Token limit for the model.
-              example: "2048"
-            top_k:
-              type: string
-              description: Top-k setting for the model.
-              example: "0"
+              example: 0.7
             top_p:
-              type: string
-              description: Top-p setting for the model.
-              example: "1"
+              example: 0.95
             stream:
-              type: string
-              description: Indicates if streaming is enabled.
-              example: "true"
+              example: true
+            max_tokens:
+              example: 4096
+            stop:
+              example: []
+            frequency_penalty:
+              example: 0
+            presence_penalty:
+              example: 0
           additionalProperties: false
         metadata:
-          type: object
-          description: Additional metadata.
-        assets:
-          type: array
-          items:
+          author:
             type: string
-          description: List of assets related to the model.
-      required:
-        - source_url
+            example: Jan
+          tags:
+            example: ["7B", "Merged", "Featured"]
+          size:
+            example: 4370000000,
+          cover:
+            example: "https://raw.githubusercontent.com/janhq/jan/main/models/trinity-v1.2-7b/cover.png"
+        engine:
+          example: nitro
     ModelObject:
       type: object
       properties:
@@ -125,7 +96,7 @@ components:
           type: string
           description: |
             The identifier of the model.
-          example: zephyr-7b
+          example: ztrinity-v1.2-7b
         object:
           type: string
           description: |
@@ -145,197 +116,82 @@ components:
     GetModelResponse:
       type: object
       properties:
-        id:
-          type: string
-          description: The identifier of the model.
-          example: zephyr-7b
-        object:
-          type: string
-          description: Type of the object, indicating it's a model.
-          default: model
-        created:
-          type: integer
-          format: int64
-          description: Unix timestamp representing the creation time of the model.
-        owned_by:
-          type: string
-          description: The entity that owns the model.
-          example: _
-        state:
-          type: string
-          enum:
-            - not_downloaded
-            - downloaded
-            - running
-            - stopped
-          description: The current state of the model.
         source_url:
           type: string
           format: uri
           description: URL to the source of the model.
-          example: https://huggingface.co/TheBloke/zephyr-7B-beta-GGUF/blob/main/zephyr-7b-beta.Q4_K_M.gguf
-        engine_parameters:
-          type: object
-          properties:
-            pre_prompt:
-              type: string
-              description: Predefined prompt used for setting up internal configurations.
-              default: ""
-              example: Initial setup complete.
-            system_prompt:
-              type: string
-              description: Prefix used for system-level prompts.
-              default: "SYSTEM: "
-            user_prompt:
-              type: string
-              description: Prefix used for user prompts.
-              default: "USER: "
-            ai_prompt:
-              type: string
-              description: Prefix used for assistant prompts.
-              default: "ASSISTANT: "
-            ngl:
-              type: integer
-              description: Number of neural network layers loaded onto the GPU for
-                acceleration.
-              minimum: 0
-              maximum: 100
-              default: 100
-              example: 100
-            ctx_len:
-              type: integer
-              description: Context length for model operations, varies based on the specific
-                model.
-              minimum: 128
-              maximum: 4096
-              default: 2048
-              example: 2048
-            n_parallel:
-              type: integer
-              description: Number of parallel operations, relevant when continuous batching is
-                enabled.
-              minimum: 1
-              maximum: 10
-              default: 1
-              example: 4
-            cont_batching:
-              type: boolean
-              description: Indicates if continuous batching is used for processing.
-              default: false
-              example: false
-            cpu_threads:
-              type: integer
-              description: Number of threads allocated for CPU-based inference.
-              minimum: 1
-              example: 8
-            embedding:
-              type: boolean
-              description: Indicates if embedding layers are enabled in the model.
-              default: true
-              example: true
-        model_parameters:
+          example: https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.2-GGUF/resolve/main/mistral-7b-instruct-v0.2.Q4_K_M.gguf
+        id:
+          type: string
+          description:
+            Unique identifier used in chat-completions model_name, matches
+            folder name.
+          example: mistral-ins-7b-q4
+        object:
+          type: string
+          example: model
+        name:
+          type: string
+          description: Name of the model.
+          example: Mistral Instruct 7B Q4
+        version:
+          type: string
+          default: "1.0"
+          description: The version number of the model.
+        description:
+          type: string
+          description: Description of the model.
+          example: Trinity is an experimental model merge using the Slerp method. Recommended for daily assistance purposes.
+        format:
+          type: string
+          description: State format of the model, distinct from the engine.
+          example: gguf
+        settings:
           type: object
           properties:
             ctx_len:
               type: integer
-              description: Maximum context length the model can handle.
-              minimum: 0
-              maximum: 4096
-              default: 2048
-              example: 2048
-            ngl:
-              type: integer
-              description: Number of layers in the neural network.
-              minimum: 1
-              maximum: 100
-              default: 100
-              example: 100
-            embedding:
-              type: boolean
-              description: Indicates if embedding layers are used.
-              default: true
-              example: true
-            n_parallel:
-              type: integer
-              description: Number of parallel processes the model can run.
-              minimum: 1
-              maximum: 10
-              default: 1
-              example: 4
+              description: Context length.
+              example: 4096
+            prompt_template:
+              type: string
+              example: "[INST] {prompt} [/INST]"
+          additionalProperties: false
+        parameters:
+          type: object
+          properties:
             temperature:
-              type: number
-              description: Controls randomness in model's responses. Higher values lead to
-                more random responses.
-              minimum: 0
-              maximum: 2
-              default: 0.7
               example: 0.7
-            token_limit:
-              type: integer
-              description: Maximum number of tokens the model can generate in a single
-                response.
-              minimum: 1
-              maximum: 4096
-              default: 2048
-              example: 2048
-            top_k:
-              type: integer
-              description: Limits the model to consider only the top k most likely next tokens
-                at each step.
-              minimum: 0
-              maximum: 100
-              default: 0
-              example: 0
             top_p:
-              type: number
-              description: Nucleus sampling parameter. The model considers the smallest set of
-                tokens whose cumulative probability exceeds the top_p value.
-              minimum: 0
-              maximum: 1
-              default: 1
-              example: 1
+              example: 0.95
+            stream:
+              example: true
+            max_tokens:
+              example: 4096
+            stop:
+              example: []
+            frequency_penalty:
+              example: 0
+            presence_penalty:
+              example: 0
+          additionalProperties: false
         metadata:
-          type: object
-          properties:
-            engine:
-              type: string
-              description: The engine used by the model.
-              enum:
-                - nitro
-                - openai
-                - hf_inference
-            quantization:
-              type: string
-              description: Quantization parameter of the model.
-              example: Q3_K_L
-            size:
-              type: string
-              description: Size of the model.
-              example: 7B
-      required:
-        - id
-        - object
-        - created
-        - owned_by
-        - state
-        - source_url
-        - parameters
-        - metadata
+          author:
+            type: string
+            example: MistralAI
+          tags:
+            example: ["7B", "Featured", "Foundation Model"]
+          size:
+            example: 4370000000,
+          cover:
+            example: "https://raw.githubusercontent.com/janhq/jan/main/models/mistral-ins-7b-q4/cover.png"
+        engine:
+          example: nitro
     DeleteModelResponse:
       type: object
       properties:
-        id:
-          type: string
-          description: The identifier of the model that was deleted.
-          example: model-zephyr-7B
-        object:
-          type: string
-          description: Type of the object, indicating it's a model.
-          default: model
-        deleted:
-          type: boolean
-          description: Indicates whether the model was successfully deleted.
-          example: true
+        message:
+          example: Not found
     StartModelResponse:
       type: object
       properties:

From ce68ccf178c776dbdcda68132b95539fad93c383 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Wed, 24 Jan 2024 01:47:49 +0900
Subject: [PATCH 08/20] docs: change 127.0.0.1 to localhost

---
 docs/openapi/jan.yaml | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/docs/openapi/jan.yaml b/docs/openapi/jan.yaml
index 9981f7308..90e6b9945 100644
--- a/docs/openapi/jan.yaml
+++ b/docs/openapi/jan.yaml
@@ -68,7 +68,7 @@ paths:
         - lang: cURL
           source: |
             curl -X 'POST' \
-              'http://127.0.0.1:1337/v1/chat/completions' \
+              'http://localhost:1337/v1/chat/completions' \
               -H 'accept: application/json' \
               -H 'Content-Type: application/json' \
               -d '{
@@ -115,7 +115,7 @@ paths:
         - lang: cURL
           source: |
             curl -X 'GET' \
-              'http://127.0.0.1:1337/v1/models' \
+              'http://localhost:1337/v1/models' \
               -H 'accept: application/json'
   "/models/download/{model_id}":
     get:
@@ -145,7 +145,7 @@ paths:
         - lang: cURL
           source: |
             curl -X 'GET' \
-              'http://127.0.0.1:1337/v1/models/download/{model_id}' \
+              'http://localhost:1337/v1/models/download/{model_id}' \
               -H 'accept: application/json'
   "/models/{model_id}":
     get:
@@ -178,7 +178,7 @@ paths:
         - lang: cURL
           source: |
             curl -X 'GET' \
-              'http://127.0.0.1:1337/v1/models/{model_id}' \
+              'http://localhost:1337/v1/models/{model_id}' \
               -H 'accept: application/json'
     delete:
       operationId: deleteModel
@@ -209,7 +209,7 @@ paths:
         - lang: cURL
           source: |
             curl -X 'DELETE' \
-              'http://127.0.0.1:1337/v1/models/{model_id}' \
+              'http://localhost:1337/v1/models/{model_id}' \
               -H 'accept: application/json'
   /threads:
     post:

From b2d0add0060b29b61b1f3520a0a578d4c9c33471 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Wed, 24 Jan 2024 10:33:44 +0900
Subject: [PATCH 09/20] docs: add more details

---
 .../01-overview/04-install-and-prerequisites.md   | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/docs/docs/developer/01-overview/04-install-and-prerequisites.md b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
index 25fe2550e..6d9feeb14 100644
--- a/docs/docs/developer/01-overview/04-install-and-prerequisites.md
+++ b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
@@ -20,12 +20,19 @@ keywords:
 
 ## Requirements
 
+### Hardware Requirements
+
+Ensure your system meets the following specifications to guarantee a smooth development experience:
+
 - [Hardware Requirements](../../guides/02-installation/06-hardware.md)
 
-- System Requirements:
-  - [Windows](../../install/windows/#system-requirements)
-  - [MacOS](../../install/mac/#system-requirements)
-  - [Linux](../../install/linux/#system-requirements)
+### System Requirements
+
+Make sure your operating system meets the specific requirements for Jan development:
+
+- [Windows](../../install/windows/#system-requirements)
+- [MacOS](../../install/mac/#system-requirements)
+- [Linux](../../install/linux/#system-requirements)
 
 ## Prerequisites
 

From 89bec2a8a9d5703c065083c540306e7da2bb3831 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Wed, 24 Jan 2024 10:44:05 +0900
Subject: [PATCH 10/20] docs: fix typo

---
 docs/docs/developer/01-overview/04-install-and-prerequisites.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/docs/developer/01-overview/04-install-and-prerequisites.md b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
index 6d9feeb14..110f62e36 100644
--- a/docs/docs/developer/01-overview/04-install-and-prerequisites.md
+++ b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
@@ -50,7 +50,7 @@ cd jan
 git checkout -b DESIRED_BRANCH
 ```
 
-2. **Install Dependencie:s**
+2. **Install Dependencies**
 
 ```bash
 yarn install

From 45c08597fefadf35d76d187e05578b72a77288ea Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Wed, 24 Jan 2024 10:52:48 +0900
Subject: [PATCH 11/20] docs: update DeleteModelResponse

---
 docs/openapi/specs/models.yaml | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/docs/openapi/specs/models.yaml b/docs/openapi/specs/models.yaml
index 791d14880..776ffbd6d 100644
--- a/docs/openapi/specs/models.yaml
+++ b/docs/openapi/specs/models.yaml
@@ -190,8 +190,18 @@ components:
     DeleteModelResponse:
       type: object
       properties:
-        message:
-          example: Not found
+        id:
+          type: string
+          description: The identifier of the model that was deleted.
+          example: mistral-ins-7b-q4
+        object:
+          type: string
+          description: Type of the object, indicating it's a model.
+          default: model
+        deleted:
+          type: boolean
+          description: Indicates whether the model was successfully deleted.
+          example: true
     StartModelResponse:
       type: object
       properties:

From b4ffe006fed494f610c3248892c57ec711b6799f Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Wed, 24 Jan 2024 10:55:24 +0900
Subject: [PATCH 12/20] docs: format .yaml

---
 docs/openapi/specs/assistants.yaml |  2 +-
 docs/openapi/specs/chat.yaml       | 17 +++++++++++------
 docs/openapi/specs/messages.yaml   |  2 +-
 docs/openapi/specs/models.yaml     |  2 +-
 docs/openapi/specs/threads.yaml    |  2 +-
 5 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/docs/openapi/specs/assistants.yaml b/docs/openapi/specs/assistants.yaml
index d784c315a..5db1f6a97 100644
--- a/docs/openapi/specs/assistants.yaml
+++ b/docs/openapi/specs/assistants.yaml
@@ -316,4 +316,4 @@ components:
         deleted:
           type: boolean
           description: Indicates whether the assistant was successfully deleted.
-          example: true
\ No newline at end of file
+          example: true
diff --git a/docs/openapi/specs/chat.yaml b/docs/openapi/specs/chat.yaml
index b324501a8..3aeff380f 100644
--- a/docs/openapi/specs/chat.yaml
+++ b/docs/openapi/specs/chat.yaml
@@ -16,7 +16,8 @@ components:
         stream:
           type: boolean
           default: true
-          description: Enables continuous output generation, allowing for streaming of
+          description:
+            Enables continuous output generation, allowing for streaming of
             model responses.
         model:
           type: string
@@ -25,23 +26,27 @@ components:
         max_tokens:
           type: number
           default: 2048
-          description: The maximum number of tokens the model will generate in a single
+          description:
+            The maximum number of tokens the model will generate in a single
             response.
         stop:
           type: arrays
           example:
             - hello
-          description: Defines specific tokens or phrases at which the model will stop
+          description:
+            Defines specific tokens or phrases at which the model will stop
             generating further output/
         frequency_penalty:
           type: number
           default: 0
-          description: Adjusts the likelihood of the model repeating words or phrases in
+          description:
+            Adjusts the likelihood of the model repeating words or phrases in
             its output.
         presence_penalty:
           type: number
           default: 0
-          description: Influences the generation of new and varied concepts in the model's
+          description:
+            Influences the generation of new and varied concepts in the model's
             output.
         temperature:
           type: number
@@ -188,4 +193,4 @@ components:
             total_tokens:
               type: integer
               example: 533
-              description: Total number of tokens used
\ No newline at end of file
+              description: Total number of tokens used
diff --git a/docs/openapi/specs/messages.yaml b/docs/openapi/specs/messages.yaml
index d9d7d87a4..9a0799f6a 100644
--- a/docs/openapi/specs/messages.yaml
+++ b/docs/openapi/specs/messages.yaml
@@ -309,4 +309,4 @@ components:
         data:
           type: array
           items:
-            $ref: "#/components/schemas/MessageFileObject"
\ No newline at end of file
+            $ref: "#/components/schemas/MessageFileObject"
diff --git a/docs/openapi/specs/models.yaml b/docs/openapi/specs/models.yaml
index 776ffbd6d..21276f899 100644
--- a/docs/openapi/specs/models.yaml
+++ b/docs/openapi/specs/models.yaml
@@ -96,7 +96,7 @@ components:
           type: string
           description: |
             The identifier of the model.
-          example: ztrinity-v1.2-7b
+          example: trinity-v1.2-7b
         object:
           type: string
           description: |
diff --git a/docs/openapi/specs/threads.yaml b/docs/openapi/specs/threads.yaml
index fe00f7588..825f166f1 100644
--- a/docs/openapi/specs/threads.yaml
+++ b/docs/openapi/specs/threads.yaml
@@ -224,4 +224,4 @@ components:
         deleted:
           type: boolean
           description: Indicates whether the thread was successfully deleted.
-          example: true
\ No newline at end of file
+          example: true

From 64cabe3d56c6759688cf71555a43b6d469d05818 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Wed, 24 Jan 2024 11:37:08 +0900
Subject: [PATCH 13/20] chore: lint .yaml

---
 docs/openapi/jan.yaml            | 42 ++++++++++++++---------------
 docs/openapi/specs/chat.yaml     | 15 ++++-------
 docs/openapi/specs/messages.yaml | 45 ++++++++++++++++----------------
 docs/openapi/specs/models.yaml   | 22 +++++++++++-----
 docs/openapi/specs/threads.yaml  |  2 +-
 5 files changed, 66 insertions(+), 60 deletions(-)

diff --git a/docs/openapi/jan.yaml b/docs/openapi/jan.yaml
index 90e6b9945..864c80fdf 100644
--- a/docs/openapi/jan.yaml
+++ b/docs/openapi/jan.yaml
@@ -72,27 +72,27 @@ paths:
               -H 'accept: application/json' \
               -H 'Content-Type: application/json' \
               -d '{
-              "messages": [
-                {
-                  "content": "You are a helpful assistant.",
-                  "role": "system"
-                },
-                {
-                  "content": "Hello!",
-                  "role": "user"
-                }
-              ],
-              "model": "tinyllama-1.1b",
-              "stream": true,
-              "max_tokens": 2048,
-              "stop": [
-                "hello"
-              ],
-              "frequency_penalty": 0,
-              "presence_penalty": 0,
-              "temperature": 0.7,
-              "top_p": 0.95
-            }'
+                "messages": [
+                  {
+                    "content": "You are a helpful assistant.",
+                    "role": "system"
+                  },
+                  {
+                    "content": "Hello!",
+                    "role": "user"
+                  }
+                ],
+                "model": "tinyllama-1.1b",
+                "stream": true,
+                "max_tokens": 2048,
+                "stop": [
+                  "hello"
+                ],
+                "frequency_penalty": 0,
+                "presence_penalty": 0,
+                "temperature": 0.7,
+                "top_p": 0.95
+              }'
   /models:
     get:
       operationId: listModels
diff --git a/docs/openapi/specs/chat.yaml b/docs/openapi/specs/chat.yaml
index 3aeff380f..cfa391598 100644
--- a/docs/openapi/specs/chat.yaml
+++ b/docs/openapi/specs/chat.yaml
@@ -16,8 +16,7 @@ components:
         stream:
           type: boolean
           default: true
-          description:
-            Enables continuous output generation, allowing for streaming of
+          description: Enables continuous output generation, allowing for streaming of
             model responses.
         model:
           type: string
@@ -26,27 +25,23 @@ components:
         max_tokens:
           type: number
           default: 2048
-          description:
-            The maximum number of tokens the model will generate in a single
+          description: The maximum number of tokens the model will generate in a single
             response.
         stop:
           type: arrays
           example:
             - hello
-          description:
-            Defines specific tokens or phrases at which the model will stop
+          description: Defines specific tokens or phrases at which the model will stop
             generating further output/
         frequency_penalty:
           type: number
           default: 0
-          description:
-            Adjusts the likelihood of the model repeating words or phrases in
+          description: Adjusts the likelihood of the model repeating words or phrases in
             its output.
         presence_penalty:
           type: number
           default: 0
-          description:
-            Influences the generation of new and varied concepts in the model's
+          description: Influences the generation of new and varied concepts in the model's
             output.
         temperature:
           type: number
diff --git a/docs/openapi/specs/messages.yaml b/docs/openapi/specs/messages.yaml
index 9a0799f6a..6f5fe1a58 100644
--- a/docs/openapi/specs/messages.yaml
+++ b/docs/openapi/specs/messages.yaml
@@ -1,3 +1,4 @@
+---
 components:
   schemas:
     MessageObject:
@@ -75,7 +76,7 @@ components:
           example: msg_abc123
         object:
           type: string
-          description: "Type of the object, indicating it's a thread message."
+          description: Type of the object, indicating it's a thread message.
           default: thread.message
         created_at:
           type: integer
@@ -88,7 +89,7 @@ components:
           example: thread_abc123
         role:
           type: string
-          description: "Role of the sender, either 'user' or 'assistant'."
+          description: Role of the sender, either 'user' or 'assistant'.
           example: user
         content:
           type: array
@@ -97,7 +98,7 @@ components:
             properties:
               type:
                 type: string
-                description: "Type of content, e.g., 'text'."
+                description: Type of content, e.g., 'text'.
                 example: text
               text:
                 type: object
@@ -110,21 +111,21 @@ components:
                     type: array
                     items:
                       type: string
-                    description: "Annotations for the text content, if any."
+                    description: Annotations for the text content, if any.
                     example: []
         file_ids:
           type: array
           items:
             type: string
-          description: "Array of file IDs associated with the message, if any."
+          description: Array of file IDs associated with the message, if any.
           example: []
         assistant_id:
           type: string
-          description: "Identifier of the assistant involved in the message, if applicable."
+          description: Identifier of the assistant involved in the message, if applicable.
           example: null
         run_id:
           type: string
-          description: "Run ID associated with the message, if applicable."
+          description: Run ID associated with the message, if applicable.
           example: null
         metadata:
           type: object
@@ -139,7 +140,7 @@ components:
           example: msg_abc123
         object:
           type: string
-          description: "Type of the object, indicating it's a thread message."
+          description: Type of the object, indicating it's a thread message.
           example: thread.message
         created_at:
           type: integer
@@ -152,7 +153,7 @@ components:
           example: thread_abc123
         role:
           type: string
-          description: "Role of the sender, either 'user' or 'assistant'."
+          description: Role of the sender, either 'user' or 'assistant'.
           example: user
         content:
           type: array
@@ -161,7 +162,7 @@ components:
             properties:
               type:
                 type: string
-                description: "Type of content, e.g., 'text'."
+                description: Type of content, e.g., 'text'.
                 example: text
               text:
                 type: object
@@ -174,21 +175,21 @@ components:
                     type: array
                     items:
                       type: string
-                    description: "Annotations for the text content, if any."
+                    description: Annotations for the text content, if any.
                     example: []
         file_ids:
           type: array
           items:
             type: string
-          description: "Array of file IDs associated with the message, if any."
+          description: Array of file IDs associated with the message, if any.
           example: []
         assistant_id:
           type: string
-          description: "Identifier of the assistant involved in the message, if applicable."
+          description: Identifier of the assistant involved in the message, if applicable.
           example: null
         run_id:
           type: string
-          description: "Run ID associated with the message, if applicable."
+          description: Run ID associated with the message, if applicable.
           example: null
         metadata:
           type: object
@@ -199,7 +200,7 @@ components:
       properties:
         object:
           type: string
-          description: "Type of the object, indicating it's a list."
+          description: Type of the object, indicating it's a list.
           default: list
         data:
           type: array
@@ -226,7 +227,7 @@ components:
           example: msg_abc123
         object:
           type: string
-          description: "Type of the object, indicating it's a thread message."
+          description: Type of the object, indicating it's a thread message.
           example: thread.message
         created_at:
           type: integer
@@ -239,7 +240,7 @@ components:
           example: thread_abc123
         role:
           type: string
-          description: "Role of the sender, either 'user' or 'assistant'."
+          description: Role of the sender, either 'user' or 'assistant'.
           example: user
         content:
           type: array
@@ -248,7 +249,7 @@ components:
             properties:
               type:
                 type: string
-                description: "Type of content, e.g., 'text'."
+                description: Type of content, e.g., 'text'.
               text:
                 type: object
                 properties:
@@ -260,20 +261,20 @@ components:
                     type: array
                     items:
                       type: string
-                    description: "Annotations for the text content, if any."
+                    description: Annotations for the text content, if any.
         file_ids:
           type: array
           items:
             type: string
-          description: "Array of file IDs associated with the message, if any."
+          description: Array of file IDs associated with the message, if any.
           example: []
         assistant_id:
           type: string
-          description: "Identifier of the assistant involved in the message, if applicable."
+          description: Identifier of the assistant involved in the message, if applicable.
           example: null
         run_id:
           type: string
-          description: "Run ID associated with the message, if applicable."
+          description: Run ID associated with the message, if applicable.
           example: null
         metadata:
           type: object
diff --git a/docs/openapi/specs/models.yaml b/docs/openapi/specs/models.yaml
index 21276f899..40e6abaaf 100644
--- a/docs/openapi/specs/models.yaml
+++ b/docs/openapi/specs/models.yaml
@@ -43,7 +43,9 @@ components:
         description:
           type: string
           description: Description of the model.
-          example: Trinity is an experimental model merge using the Slerp method. Recommended for daily assistance purposes.
+          example:
+            Trinity is an experimental model merge using the Slerp method.
+            Recommended for daily assistance purposes.
         format:
           type: string
           description: State format of the model, distinct from the engine.
@@ -82,11 +84,14 @@ components:
             type: string
             example: Jan
           tags:
-            example: ["7B", "Merged", "Featured"]
+            example:
+              - 7B
+              - Merged
+              - Featured
           size:
             example: 4370000000,
           cover:
-            example: "https://raw.githubusercontent.com/janhq/jan/main/models/trinity-v1.2-7b/cover.png"
+            example: https://raw.githubusercontent.com/janhq/jan/main/models/trinity-v1.2-7b/cover.png
         engine:
           example: nitro
     ModelObject:
@@ -141,7 +146,9 @@ components:
         description:
           type: string
           description: Description of the model.
-          example: Trinity is an experimental model merge using the Slerp method. Recommended for daily assistance purposes.
+          example:
+            Trinity is an experimental model merge using the Slerp method.
+            Recommended for daily assistance purposes.
         format:
           type: string
           description: State format of the model, distinct from the engine.
@@ -180,11 +187,14 @@ components:
             type: string
             example: MistralAI
           tags:
-            example: ["7B", "Featured", "Foundation Model"]
+            example:
+              - 7B
+              - Featured
+              - Foundation Model
           size:
             example: 4370000000,
           cover:
-            example: "https://raw.githubusercontent.com/janhq/jan/main/models/mistral-ins-7b-q4/cover.png"
+            example: https://raw.githubusercontent.com/janhq/jan/main/models/mistral-ins-7b-q4/cover.png
         engine:
           example: nitro
     DeleteModelResponse:
diff --git a/docs/openapi/specs/threads.yaml b/docs/openapi/specs/threads.yaml
index 825f166f1..40b2463fa 100644
--- a/docs/openapi/specs/threads.yaml
+++ b/docs/openapi/specs/threads.yaml
@@ -142,7 +142,7 @@ components:
                 example: Jan
               instructions:
                 type: string
-                description: |
+                description: >
                   The instruction of assistant, defaults to "Be my grammar corrector"
               model:
                 type: object

From 49670a84c3d0e96fccb7abe2016f1665972d1231 Mon Sep 17 00:00:00 2001
From: hiento09 <136591877+hiento09@users.noreply.github.com>
Date: Thu, 25 Jan 2024 21:49:44 +0700
Subject: [PATCH 14/20] Update 06-unexpected-token.mdx

---
 docs/docs/guides/08-troubleshooting/06-unexpected-token.mdx | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/docs/docs/guides/08-troubleshooting/06-unexpected-token.mdx b/docs/docs/guides/08-troubleshooting/06-unexpected-token.mdx
index 973001f1b..1de609ffa 100644
--- a/docs/docs/guides/08-troubleshooting/06-unexpected-token.mdx
+++ b/docs/docs/guides/08-troubleshooting/06-unexpected-token.mdx
@@ -17,4 +17,8 @@ keywords:
   ]
 ---
 
-1. You may receive an error response `Error occurred: Unexpected token '<', "<!DOCTYPE"...is not valid JSON`, when you start a chat with OpenAI models. Using a VPN may help fix the issue.
+You may receive an error response `Error occurred: Unexpected token '<', "<!DOCTYPE"...is not valid JSON`, when you start a chat with OpenAI models. 
+
+1. Check that you added an OpenAI API key. You can get an API key from OpenAI's [developer platform](https://platform.openai.com/). Alternatively, we recommend you download a local model from Jan Hub, which remains free to use and runs on your own computer!
+
+2. Using a VPN may help fix the issue.

From 4e3f1a522e83950a4b45118b032db6f1bfa013a7 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Fri, 26 Jan 2024 01:09:24 +0900
Subject: [PATCH 15/20] docs: add additional reasons to somethings amiss

---
 docs/docs/guides/08-troubleshooting/02-somethings-amiss.mdx | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/docs/guides/08-troubleshooting/02-somethings-amiss.mdx b/docs/docs/guides/08-troubleshooting/02-somethings-amiss.mdx
index a5669e36d..4e16e362a 100644
--- a/docs/docs/guides/08-troubleshooting/02-somethings-amiss.mdx
+++ b/docs/docs/guides/08-troubleshooting/02-somethings-amiss.mdx
@@ -45,7 +45,9 @@ This may occur due to several reasons. Please follow these steps to resolve it:
 
 5. If you are on Nvidia GPUs, please download [Cuda](https://developer.nvidia.com/cuda-downloads).
 
-6. When [checking app logs](https://jan.ai/troubleshooting/how-to-get-error-logs/), if you encounter the error log `Bind address failed at 127.0.0.1:3928`, it indicates that the port used by Nitro might already be in use. Use the following commands to check the port status:
+6. If you're using Linux, please ensure that your system meets the following requirements gcc 11, g++ 11, cpp 11, or higher, refer to this [link](https://jan.ai/guides/troubleshooting/gpu-not-used/#specific-requirements-for-linux) for more information.
+
+7. When [checking app logs](https://jan.ai/troubleshooting/how-to-get-error-logs/), if you encounter the error log `Bind address failed at 127.0.0.1:3928`, it indicates that the port used by Nitro might already be in use. Use the following commands to check the port status:
 
 <Tabs groupId="operating-systems">
   <TabItem value="mac" label="macOS">

From d26e97f4a7b13dde738074d41757c1f0dd0be431 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Fri, 26 Jan 2024 01:33:45 +0900
Subject: [PATCH 16/20] docs: add OpenAI model list

---
 .../04-using-models/03-integrate-with-remote-server.mdx    | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/docs/guides/04-using-models/03-integrate-with-remote-server.mdx b/docs/docs/guides/04-using-models/03-integrate-with-remote-server.mdx
index 533797fca..f0db1bd55 100644
--- a/docs/docs/guides/04-using-models/03-integrate-with-remote-server.mdx
+++ b/docs/docs/guides/04-using-models/03-integrate-with-remote-server.mdx
@@ -65,6 +65,13 @@ Navigate to the `~/jan/models` folder. Create a folder named `gpt-3.5-turbo-16k`
 }
 ```
 
+:::tip
+
+- You can find the list of available models in the [OpenAI Platform](https://platform.openai.com/docs/models/overview).
+- Please note that the `id` property need to match the model name in the list. For example, if you want to use the [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo), you need to set the `id` property as `gpt-4-1106-preview`.
+
+:::
+
 ### 2. Configure OpenAI API Keys
 
 You can find your API keys in the [OpenAI Platform](https://platform.openai.com/api-keys) and set the OpenAI API keys in `~/jan/engines/openai.json` file.

From ae23127ddb5a25ce5e55772481fde44e72585d3e Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Fri, 2 Feb 2024 07:53:01 +0900
Subject: [PATCH 17/20] docs: add trouble 07-undefined-issue

---
 .../08-troubleshooting/07-undefined-issue.mdx | 26 +++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 docs/docs/guides/08-troubleshooting/07-undefined-issue.mdx

diff --git a/docs/docs/guides/08-troubleshooting/07-undefined-issue.mdx b/docs/docs/guides/08-troubleshooting/07-undefined-issue.mdx
new file mode 100644
index 000000000..b45bfd86e
--- /dev/null
+++ b/docs/docs/guides/08-troubleshooting/07-undefined-issue.mdx
@@ -0,0 +1,26 @@
+---
+title: Undefined Issue
+slug: /troubleshooting/undefined-issue
+description: Undefined issue troubleshooting guide.
+keywords:
+  [
+    Jan AI,
+    Jan,
+    ChatGPT alternative,
+    local AI,
+    private AI,
+    conversational AI,
+    no-subscription fee,
+    large language model,
+    troubleshooting,
+    undefined issue,
+  ]
+---
+
+You may encounter an "undefined" issue when using Jan. Here are some troubleshooting steps to help you resolve the issue.
+
+1. Try wiping the Jan folder and reopening the Jan app and see if the issue persists.
+2. If the issue persists, try to go `~/jan/extensions/@janhq/inference-nitro-extensions/dist/bin/<your-os>/nitro` and run the nitro manually and see if you get any error messages.
+3. Resolve the error messages you get from the nitro and see if the issue persists.
+4. Reopen the Jan app and see if the issue is resolved.
+5. If the issue persists, please contact us at [Jan Discord](https://discord.gg/mY69SZaMaC).

From 8ff04f4db96340546809af7e027a4105abc043c0 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Fri, 2 Feb 2024 10:03:39 +0900
Subject: [PATCH 18/20] docs: add app log

---
 docs/docs/guides/08-troubleshooting/07-undefined-issue.mdx | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/docs/guides/08-troubleshooting/07-undefined-issue.mdx b/docs/docs/guides/08-troubleshooting/07-undefined-issue.mdx
index b45bfd86e..4aba6438d 100644
--- a/docs/docs/guides/08-troubleshooting/07-undefined-issue.mdx
+++ b/docs/docs/guides/08-troubleshooting/07-undefined-issue.mdx
@@ -23,4 +23,4 @@ You may encounter an "undefined" issue when using Jan. Here are some troubleshoo
 2. If the issue persists, try to go `~/jan/extensions/@janhq/inference-nitro-extensions/dist/bin/<your-os>/nitro` and run the nitro manually and see if you get any error messages.
 3. Resolve the error messages you get from the nitro and see if the issue persists.
 4. Reopen the Jan app and see if the issue is resolved.
-5. If the issue persists, please contact us at [Jan Discord](https://discord.gg/mY69SZaMaC).
+5. If the issue persists, please share with us the [app logs](https://jan.ai/troubleshooting/how-to-get-error-logs/) via [Jan Discord](https://discord.gg/mY69SZaMaC).

From ce63e1805e403d83f746e60912455e1f5c9b33e2 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Fri, 2 Feb 2024 15:03:18 +0900
Subject: [PATCH 19/20] docs: update what is tracked

---
 docs/docs/about/01-README.md | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/docs/docs/about/01-README.md b/docs/docs/about/01-README.md
index 3b2759513..c69a35751 100644
--- a/docs/docs/about/01-README.md
+++ b/docs/docs/about/01-README.md
@@ -111,8 +111,9 @@ Adhering to Jan's privacy preserving philosophy, our analytics philosophy is to
 #### What is tracked
 
 1. By default, Github tracks downloads and device metadata for all public Github repos. This helps us troubleshoot & ensure cross platform support.
-1. We use Posthog to track a single `app.opened` event without additional user metadata, in order to understand retention.
-1. Additionally, we plan to enable a `Settings` feature for users to turn off all tracking.
+2. We use [Umami](https://umami.is/) to collect, analyze, and understand application data while maintaining visitor privacy and data ownership. We are using the Umami Cloud in Europe to ensure GDPR compliant. Please see [Umami Privacy Policy](https://umami.is/privacy) for more details.
+3. We use Umami to track a single `app.opened` event without additional user metadata, in order to understand retention. In addition, we track `app.event` to understand app version usage.
+4. Additionally, we plan to enable a `Settings` feature for users to turn off all tracking.
 
 #### Request for help
 

From f7c591eca994d0719e0c94bfc0fffdfc7d494722 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Fri, 2 Feb 2024 15:08:39 +0900
Subject: [PATCH 20/20] docs: fix typo

---
 docs/docs/about/01-README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/docs/about/01-README.md b/docs/docs/about/01-README.md
index c69a35751..d5d3b8dc2 100644
--- a/docs/docs/about/01-README.md
+++ b/docs/docs/about/01-README.md
@@ -110,8 +110,8 @@ Adhering to Jan's privacy preserving philosophy, our analytics philosophy is to
 
 #### What is tracked
 
-1. By default, Github tracks downloads and device metadata for all public Github repos. This helps us troubleshoot & ensure cross platform support.
-2. We use [Umami](https://umami.is/) to collect, analyze, and understand application data while maintaining visitor privacy and data ownership. We are using the Umami Cloud in Europe to ensure GDPR compliant. Please see [Umami Privacy Policy](https://umami.is/privacy) for more details.
+1. By default, Github tracks downloads and device metadata for all public GitHub repositories. This helps us troubleshoot & ensure cross-platform support.
+2. We use [Umami](https://umami.is/) to collect, analyze, and understand application data while maintaining visitor privacy and data ownership. We are using the Umami Cloud in Europe to ensure GDPR compliance. Please see [Umami Privacy Policy](https://umami.is/privacy) for more details.
 3. We use Umami to track a single `app.opened` event without additional user metadata, in order to understand retention. In addition, we track `app.event` to understand app version usage.
 4. Additionally, we plan to enable a `Settings` feature for users to turn off all tracking.