Skip to content

Commit aa27f77

Browse files
Change file path to relative path
Not absolute path
1 parent 699916b commit aa27f77

4 files changed

Lines changed: 25 additions & 7 deletions

File tree

docs/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Groq Whisper API、OpenAI API 等国外大模型/推理平台 API 一般无法
6969
Docker是**最适合小白**的部署方式,它可以一键部署所有组件,无需手动配置。
7070
:::
7171

72-
如果你对 Docker 感兴趣,请移步[Docker 部署指南](/docs/user-guide/backend/docker.md)
72+
如果你对 Docker 感兴趣,请移步[Docker 部署指南](./user-guide/backend/docker.md)
7373

7474
如果不感兴趣,您也可以跳转到常规配置方法,从下一步,也就是[环境准备](#环境准备)步骤开始。
7575

docs/user-guide/backend/docker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
1010
## 下载配置文件
1111

1212
### git下载(适合有git基础的用户)
13-
[按照Quick Start安装 git](/docs/quick-start.md#安装-git)
13+
[按照Quick Start安装 git](../../quick-start.md#安装-git)
1414
, 然后下载docker用户配置文件:
1515

1616
```bash
@@ -47,7 +47,7 @@ git clone https://github.com/Open-LLM-VTuber/OLV-Docker-Config
4747
:::
4848

4949
:::caution 关于GPU支持
50-
目前**仅支持CPU和Nvidia GPU**, 且GPU需要配置好Nvidia驱动, 如果还没配置好, 请[**点击这里前往Quick Start查看配置攻略**](/docs/quick-start.md#nvidia-gpu-支持)
50+
目前**仅支持CPU和Nvidia GPU**, 且GPU需要配置好Nvidia驱动, 如果还没配置好, 请[**点击这里前往Quick Start查看配置攻略**](../../quick-start.md#nvidia-gpu-支持)
5151

5252
如果您不打算使用GPU,而是**调用api**(这也是**绝大多数用户体验最好的方式**),或者使用CPU,可以忽略此步。
5353
:::
@@ -151,7 +151,7 @@ openllmvtuber/open-llm-vtuber:latest
151151
</details>
152152
:::
153153

154-
更多注意事项,可以参考 [Quick Start 里的配置 LLM 部分](/docs/quick-start.md#3-配置-llm)
154+
更多注意事项,可以参考 [Quick Start 里的配置 LLM 部分](../../quick-start.md#3-配置-llm)
155155

156156

157157
### 运行 Docker 容器

i18n/en/docusaurus-plugin-content-docs/current/quick-start.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,24 @@ This project supports various backends for speech recognition (ASR), large langu
5555

5656
For the components selected in this quick start guide, you will need a CPU with normal speed (for ASR), a GPU supported by Ollama (for LLM), and an internet connection (for TTS).
5757

58+
## Docker Quick Start
59+
60+
:::info Note
61+
Docker is the easiest deployment method for beginners. It can deploy all components with one click and requires no manual configuration.
62+
:::
63+
64+
If you're interested in Docker, please refer to the [Docker Deployment Guide](./user-guide/backend/docker.md).
65+
66+
If you're not interested, you can skip ahead to the general setup and start from the next step: [Environment Preparation](#environment-preparation).
67+
68+
:::note Current Docker image platform support is as follows
69+
| Platform | CPU Support | NVIDIA GPU Support | AMD/Intel GPU Support |
70+
|----------|-------------|--------------------|-----------------------|
71+
| Linux ||||
72+
| Windows ||[(requires Nvidia driver installation)](#nvidia-gpu-support) ||
73+
| macOS ||||
74+
:::
75+
5876
## Environment Preparation
5977

6078
### Install Git

i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/docker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
1010
## Download configuration files
1111

1212
### Git clone (for users familiar with git)
13-
First, [install git following the Quick Start](/docs/quick-start.md#安装-git), then download the Docker user configuration:
13+
First, [install git following the Quick Start](../../quick-start.md#install-git), then download the Docker user configuration:
1414

1515
```bash
1616
git clone https://github.com/Open-LLM-VTuber/OLV-Docker-Config
@@ -48,7 +48,7 @@ Two installation methods are supported currently:
4848
:::
4949

5050
:::caution About GPU support
51-
Currently **only CPU and Nvidia GPU** are supported. Nvidia GPUs require proper Nvidia driver configuration. If you haven't set it up yet, please [**click here to view the setup guide in Quick Start**](/docs/quick-start.md#nvidia-gpu-支持).
51+
Currently **only CPU and Nvidia GPU** are supported. Nvidia GPUs require proper Nvidia driver configuration. If you haven't set it up yet, please [**click here to view the setup guide in Quick Start**](../../quick-start.md#nvidia-gpu-support).
5252

5353
If you don't plan to use a GPU and will instead **use API calls** (this is **the best experience for most users**) or use CPU only, you can skip this step.
5454
:::
@@ -154,7 +154,7 @@ We recommend following these steps to use the default `Ollama` model and avoid e
154154
</details>
155155
:::
156156

157-
For more details, refer to the LLM configuration section in [Quick Start](/docs/quick-start.md#3-配置-llm).
157+
For more details, refer to the LLM configuration section in [Quick Start](/docs/quick-start.md#3-configure-llm).
158158

159159
### Run the Docker container
160160

0 commit comments

Comments
 (0)