diff --git a/docs/docs/operation_manual/advanced_tutorial/debugging.md b/docs/docs/application_manual/advanced_tutorial/debugging.md similarity index 100% rename from docs/docs/operation_manual/advanced_tutorial/debugging.md rename to docs/docs/application_manual/advanced_tutorial/debugging.md diff --git a/docs/docs/operation_manual/advanced_tutorial/rag.md b/docs/docs/application_manual/advanced_tutorial/rag.md similarity index 100% rename from docs/docs/operation_manual/advanced_tutorial/rag.md rename to docs/docs/application_manual/advanced_tutorial/rag.md diff --git a/docs/docs/operation_manual/advanced_tutorial/smmf.md b/docs/docs/application_manual/advanced_tutorial/smmf.md similarity index 100% rename from docs/docs/operation_manual/advanced_tutorial/smmf.md rename to docs/docs/application_manual/advanced_tutorial/smmf.md diff --git a/docs/docs/operation_manual/fine_tuning_manual/text_to_sql.md b/docs/docs/application_manual/fine_tuning_manual/text_to_sql.md similarity index 100% rename from docs/docs/operation_manual/fine_tuning_manual/text_to_sql.md rename to docs/docs/application_manual/fine_tuning_manual/text_to_sql.md diff --git a/docs/docs/operation_manual/started_tutorial/agent.md b/docs/docs/application_manual/started_tutorial/agent.md similarity index 100% rename from docs/docs/operation_manual/started_tutorial/agent.md rename to docs/docs/application_manual/started_tutorial/agent.md diff --git a/docs/docs/operation_manual/started_tutorial/chat_dashboard.md b/docs/docs/application_manual/started_tutorial/chat_dashboard.md similarity index 100% rename from docs/docs/operation_manual/started_tutorial/chat_dashboard.md rename to docs/docs/application_manual/started_tutorial/chat_dashboard.md diff --git a/docs/docs/operation_manual/started_tutorial/chat_data.md b/docs/docs/application_manual/started_tutorial/chat_data.md similarity index 100% rename from docs/docs/operation_manual/started_tutorial/chat_data.md rename to docs/docs/application_manual/started_tutorial/chat_data.md diff --git a/docs/docs/operation_manual/started_tutorial/chat_db.md b/docs/docs/application_manual/started_tutorial/chat_db.md similarity index 100% rename from docs/docs/operation_manual/started_tutorial/chat_db.md rename to docs/docs/application_manual/started_tutorial/chat_db.md diff --git a/docs/docs/operation_manual/started_tutorial/chat_excel.md b/docs/docs/application_manual/started_tutorial/chat_excel.md similarity index 100% rename from docs/docs/operation_manual/started_tutorial/chat_excel.md rename to docs/docs/application_manual/started_tutorial/chat_excel.md diff --git a/docs/docs/operation_manual/started_tutorial/chat_knowledge.md b/docs/docs/application_manual/started_tutorial/chat_knowledge.md similarity index 99% rename from docs/docs/operation_manual/started_tutorial/chat_knowledge.md rename to docs/docs/application_manual/started_tutorial/chat_knowledge.md index 6dae5b03f..24ffc37aa 100644 --- a/docs/docs/operation_manual/started_tutorial/chat_knowledge.md +++ b/docs/docs/application_manual/started_tutorial/chat_knowledge.md @@ -27,10 +27,9 @@ Select the knowledge base, click the `Create` button, and fill in the necessary

- +

- ### Upload documents Document addition currently supports multiple types, such as plain text, URL crawling, and various document types such as PDF, Word, and Markdown. Select a specific document to `upload`. diff --git a/docs/docs/installation/sourcecode.md b/docs/docs/installation/sourcecode.md index 4ceeb9cf7..14e50bb69 100644 --- a/docs/docs/installation/sourcecode.md +++ b/docs/docs/installation/sourcecode.md @@ -26,7 +26,7 @@ git clone https://github.com/eosphoros-ai/DB-GPT.git ### Miniconda environment installation -- The default database uses SQLite, so there is no need to install a database in the default startup mode. If you need to use other databases, you can read the [advanced tutorials](/docs/operation_manual/advanced_tutorial) below. We recommend installing the Python virtual environment through the conda virtual environment. For the installation of Miniconda environment, please refer to the [Miniconda installation tutorial](https://docs.conda.io/projects/miniconda/en/latest/). +- The default database uses SQLite, so there is no need to install a database in the default startup mode. If you need to use other databases, you can read the [advanced tutorials](/docs/application_manual/advanced_tutorial) below. We recommend installing the Python virtual environment through the conda virtual environment. For the installation of Miniconda environment, please refer to the [Miniconda installation tutorial](https://docs.conda.io/projects/miniconda/en/latest/). :::tip Create a Python virtual environment diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md index cb2cad58a..e953ed2c3 100644 --- a/docs/docs/quickstart.md +++ b/docs/docs/quickstart.md @@ -1,7 +1,6 @@ --- sidebar_position: 0 --- - # Quickstart DB-GPT supports the installation and use of a variety of open source and closed models. Different models have different requirements for environment and resources. If localized model deployment is required, GPU resources are required for deployment. The API proxy model requires relatively few resources and can be deployed and started on a CPU machine. @@ -27,7 +26,7 @@ git clone https://github.com/eosphoros-ai/DB-GPT.git ### Miniconda environment installation -- The default database uses SQLite, so there is no need to install a database in the default startup mode. If you need to use other databases, you can read the [advanced tutorials](/docs/operation_manual/advanced_tutorial/rag) below. We recommend installing the Python virtual environment through the conda virtual environment. For the installation of Miniconda environment, please refer to the [Miniconda installation tutorial](https://docs.conda.io/projects/miniconda/en/latest/). +- The default database uses SQLite, so there is no need to install a database in the default startup mode. If you need to use other databases, you can read the [advanced tutorials](/docs/application_manual/advanced_tutorial/rag) below. We recommend installing the Python virtual environment through the conda virtual environment. For the installation of Miniconda environment, please refer to the [Miniconda installation tutorial](https://docs.conda.io/projects/miniconda/en/latest/). :::tip Create a Python virtual environment @@ -56,8 +55,18 @@ cp .env.template .env Provide two deployment methods to quickly start experiencing DB-GPT. ::: +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + -### Method 1. OpenAI agent mode deployment :::info note ⚠️ You need to ensure that git-lfs is installed @@ -90,9 +99,9 @@ LLM_MODEL=chatgpt_proxyllm PROXY_API_KEY={your-openai-sk} PROXY_SERVER_URL=https://api.openai.com/v1/chat/completions ``` + - -### Method 2. Vicuna local deployment + #### Hardware requirements description | Model | Quantize | VRAM Size | @@ -122,6 +131,9 @@ git clone https://huggingface.co/lmsys/vicuna-13b-v1.5 # .env LLM_MODEL=vicuna-13b-v1.5 ``` + + + ## Test data (optional) diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index c3eff6384..c8d85a3bf 100755 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -136,8 +136,8 @@ const config = { navbar: { logo: { alt: 'DB-GPT Logo', - src: 'img/dbgpt_logo.png', - srcDark: 'img/DB-GPT_LOGO_White.png', + src: 'img/dbgpt_logo.svg', + srcDark: 'img/DB-GPT_LOGO_White.svg', href: "/docs/overview" }, diff --git a/docs/sidebars.js b/docs/sidebars.js index 05b91b0c5..c81d66698 100755 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -92,37 +92,38 @@ const sidebars = { { type: "category", - label: "Operation Manual", + label: "Application Manual", collapsed: false, collapsible: false, items: [ + { type: 'category', label: 'Getting Started Tutorial', items: [ { type: 'doc', - id: 'operation_manual/started_tutorial/chat_knowledge', + id: 'application_manual/started_tutorial/chat_knowledge', }, { type: 'doc', - id: 'operation_manual/started_tutorial/chat_data', + id: 'application_manual/started_tutorial/chat_data', }, { type: 'doc', - id: 'operation_manual/started_tutorial/chat_excel', + id: 'application_manual/started_tutorial/chat_excel', }, { type: 'doc', - id: 'operation_manual/started_tutorial/chat_db', + id: 'application_manual/started_tutorial/chat_db', }, { type: 'doc', - id: 'operation_manual/started_tutorial/chat_dashboard', + id: 'application_manual/started_tutorial/chat_dashboard', }, { type: 'doc', - id: 'operation_manual/started_tutorial/agent', + id: 'application_manual/started_tutorial/agent', }, ], }, @@ -132,15 +133,15 @@ const sidebars = { items: [ { type: 'doc', - id: 'operation_manual/advanced_tutorial/rag', + id: 'application_manual/advanced_tutorial/rag', }, { type: 'doc', - id: 'operation_manual/advanced_tutorial/smmf', + id: 'application_manual/advanced_tutorial/smmf', }, { type: 'doc', - id: 'operation_manual/advanced_tutorial/debugging', + id: 'application_manual/advanced_tutorial/debugging', }, ], }, @@ -150,23 +151,17 @@ const sidebars = { items: [ { type: 'doc', - id: 'operation_manual/fine_tuning_manual/text_to_sql', + id: 'application_manual/fine_tuning_manual/text_to_sql', }, - ], }, - - - - ], link: { - type: "generated-index", - description: "DB-GPT Operation Manual", - slug: "operation_manual", - } + type: 'generated-index', + slug: "application", + }, }, - + { type: "category", label: "Modules", diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 646164deb..b816460cf 100755 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -43,6 +43,12 @@ no-repeat; } -.img { - padding: 3px; - border: 1px solid #2f15d6; } \ No newline at end of file +img { + border: 2px solid #CCCCCC; border-radius: 8px; box-shadow: 3px 3px 10px rgba(0,0,0,0.1); + } + +/* logo images are processed separately */ +.navbar__logo img { + border: none; + box-shadow: none; +} \ No newline at end of file diff --git a/docs/static/img/DB-GPT_LOGO_White.svg b/docs/static/img/DB-GPT_LOGO_White.svg new file mode 100644 index 000000000..78ab2b78d --- /dev/null +++ b/docs/static/img/DB-GPT_LOGO_White.svg @@ -0,0 +1,1064 @@ + + + + diff --git a/docs/static/img/dbgpt_logo.svg b/docs/static/img/dbgpt_logo.svg new file mode 100644 index 000000000..40841fa94 --- /dev/null +++ b/docs/static/img/dbgpt_logo.svg @@ -0,0 +1,191 @@ + + + +