Merge branch 'dev' into chore/model-run-docs-update

Author: nguyenhoangthuan99

docs/docs/architecture/cortex-db.md

@@ -0,0 +1,25 @@
+---
+title: cortex.db
+description: cortex.db Overview.
+slug: "cortex-db"
+---
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
+:::warning
+🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
+:::
+
+This document outlines the architecture of the database designed to store and manage various types of entities and their associated metadata.
+
+## Table Structure
+### models Table
+The `models` table is designed to hold metadata about various AI models. Below is the structure of the table:
+
+| Column Name        | Data Type | Description                                             |
+|--------------------|-----------|---------------------------------------------------------|
+| model_id           | TEXT      | A unique identifier for each model (Primary Key).      |
+| author_repo_id     | TEXT      | The identifier for the repository where the model is stored. |
+| branch_name        | TEXT      | The branch name in the repository that contains the model. |
+| path_to_model_yaml | TEXT      | The file path to the YAML configuration file for the model. |

docs/docs/architecture/cortex-db.mdx

@@ -16,30 +16,37 @@ Cortex.cpp supports reading its configuration from a file called `.cortexrc`. Us
 ## File Location
 The configuration file is stored in the following locations:
 
-- **Windows**:
-  - Stable: `C:\Users\<username>\.cortexrc`
-  - Beta: `C:\Users\<username>\.cortexrc-beta`
-  - Nighty: `C:\Users\<username>\.cortexrc-nightly`
-- **Linux**:
-  - Stable: `/home/<username>/.cortexrc`
-  - Beta: `/home/<username>/.cortexrc-beta`
-  - Nighty: `/home/<username>/.cortexrc-nightly`
-- **macOS**:
-  - Stable: `/Users/<username>/.cortexrc`
-  - Beta: `/Users/<username>/.cortexrc-beta`
-  - Nighty: `/Users/<username>/.cortexrc-nightly`
+- **Windows**: `C:\Users\<username>\.cortexrc`
+- **Linux**: `/home/<username>/.cortexrc`
+- **macOS**: `/Users/<username>/.cortexrc`
 
 ## Configuration Parameters
 You can configure the following parameters in the `.cortexrc` file:
 | Parameter        | Description                                      | Default Value                  |
 |------------------|--------------------------------------------------|--------------------------------|
 | `dataFolderPath` | Path to the folder where `.cortexrc` located.  | User's home folder.  |
-| `apiServerHost`  | Host address for the Cortex.cpp API server.       | `127.0.0.1`                    |
-| `apiServerPort`  | Port number for the Cortex.cpp API server.        | `39281`                         |
+| `apiServerHost`  | Host address for the Cortex.cpp API server.      | `127.0.0.1`                    |
+| `apiServerPort`  | Port number for the Cortex.cpp API server.       | `39281`                        |
+| `logFolderPath`  | Path the folder where logs are located           | User's home folder.            |
+| `logLlamaCppPath`  | The llama-cpp engine .                         | `./logs/cortex.log`            |
+| `logTensorrtLLMPath`  | The tensorrt-llm engine log file path.      | `./logs/cortex.log`            |
+| `logOnnxPath`    | The onnxruntime engine log file path.            | `./logs/cortex.log`            |
+| `maxLogLines`    | The maximum log lines that write to file.        | `100000`                       |
+| `checkedForUpdateAt`  | The last time for checking updates.         | `0`                            |
+| `latestRelease`  | The lastest release vesion.                      | Empty string                   |
+| `huggingFaceToken`  | HuggingFace token.                            | Empty string                   |
 
 Example of the `.cortexrc` file:
 ```
+logFolderPath: /Users/<username>/cortexcpp
+logLlamaCppPath: ./logs/cortex.log
+logTensorrtLLMPath: ./logs/cortex.log
+logOnnxPath: ./logs/cortex.log
 dataFolderPath: /Users/<username>/cortexcpp
+maxLogLines: 100000
 apiServerHost: 127.0.0.1
 apiServerPort: 39281
+checkedForUpdateAt: 1730501224
+latestRelease: v1.0.1
+huggingFaceToken: ""
 ```