docs: update

docs/.vitepress/config.ts

@@ -20,6 +20,7 @@ export default defineConfig({
         items: [
           { text: "安装准备", link: "/getting-started/installation" },
           { text: "配置使用", link: "/getting-started/configuration" },
+          { text: "FFmpeg 配置", link: "/getting-started/ffmpeg" },
         ],
       },
       {
@@ -29,6 +30,10 @@ export default defineConfig({
           { text: "常见问题", link: "/usage/faq" },
         ],
       },
+      {
+        text: "开发文档",
+        items: [{ text: "架构设计", link: "/develop/architecture" }],
+      },
     ],
 
     socialLinks: [

docs/develop/architecture.md

@@ -0,0 +1 @@
+# 架构设计

docs/getting-started/configuration.md

@@ -0,0 +1,21 @@
+# 配置使用
+
+## 账号配置
+
+要添加直播间，至少需要配置一个同平台的账号。在账号页面，你可以通过添加账号按钮添加一个账号。
+
+- B 站账号：目前支持扫码登录和 Cookie 手动配置两种方式
+- 抖音账号：目前仅支持 Cookie 手动配置登陆
+
+## FFmpeg 配置
+
+如果想要使用切片生成和压制功能，请确保 FFmpeg 已正确配置；除了 Windows 平台打包自带 FFfmpeg 以外，其他平台需要手动安装 FFfmpeg，请参考 [FFfmpeg 配置](/getting-started/ffmpeg)。
+
+## Whisper 模型配置
+
+要使用 AI 字幕识别功能，需要在设置页面配置 Whisper 模型路径，模型文件可以从网络上下载，例如：
+
+- [Whisper.cpp（国内镜像，内容较旧）](https://www.modelscope.cn/models/cjc1887415157/whisper.cpp/files)
+- [Whisper.cpp](https://huggingface.co/ggerganov/whisper.cpp/tree/main)
+
+可以跟据自己的需求选择不同的模型，要注意带有 `en` 的模型是英文模型，其他模型为多语言模型。

docs/getting-started/ffmpeg.md

@@ -0,0 +1,47 @@
+# FFmpeg 配置
+
+FFmpeg 是一个开源的音视频处理工具，支持多种格式的音视频编解码、转码、剪辑、合并等操作。
+在本项目中，FFmpeg 用于切片生成以及字幕和弹幕的硬编码处理，因此需要确保安装了 FFmpeg。
+
+## MacOS
+
+在 MacOS 上安装 FFmpeg 非常简单，可以使用 Homebrew 来安装：
+
+```bash
+brew install ffmpeg
+```
+
+如果没有安装 Homebrew，可以参考 [Homebrew 官网](https://brew.sh/) 进行安装。
+
+## Linux
+
+在 Linux 上安装 FFmpeg 可以使用系统自带的包管理器进行安装，例如：
+
+- Ubuntu/Debian 系统：
+
+```bash
+sudo apt install ffmpeg
+```
+
+- Fedora 系统：
+
+```bash
+sudo dnf install ffmpeg
+```
+
+- Arch Linux 系统：
+
+```bash
+sudo pacman -S ffmpeg
+```
+
+- CentOS 系统：
+
+```bash
+sudo yum install epel-release
+sudo yum install ffmpeg
+```
+
+## Windows
+
+Windows 版本安装后，FFmpeg 已经放置在了程序目录下，因此不需要额外安装。

docs/getting-started/installation.md

@@ -1,6 +1,44 @@
+# 安装准备
+
+## 桌面端安装
+
+桌面端目前提供了 Windows、Linux 和 MacOS 三个平台的安装包。
+
+安装包分为两个版本，普通版和 debug 版，普通版适合大部分用户使用，debug 版包含了更多的调试信息，适合开发者使用；由于程序会对账号等敏感信息进行管理，请从信任的来源进行下载；所有版本均可在 [GitHub Releases](https://github.com/Xinrea/bili-shadowreplay/releases) 页面下载安装。
+
+### Windows
+
+由于程序内置 Whisper 字幕识别模型支持，Windows 版本分为两种：
+
+- **普通版本**：内置了 Whisper GPU 加速，字幕识别较快，体积较大，只支持 Nvidia 显卡
+- **CPU 版本**： 使用 CPU 进行字幕识别推理，速度较慢
+
+请根据自己的显卡情况选择合适的版本进行下载。
+
+### Linux
+
+Linux 版本目前仅支持使用 CPU 推理，且测试较少，可能存在一些问题，遇到问题请及时反馈。
+
+### MacOS
+
+MacOS 版本内置 Metal GPU 加速；安装后首次运行，会提示无法打开从网络下载的软件，请在设置-隐私与安全性下，选择仍然打开以允许程序运行。
+
 ## Docker 部署
 
-BiliBili ShadowReplay 支持无界面模式，提供 Web 控制界面，可以用于在服务器等无图形界面环境下部署使用。
+BiliBili ShadowReplay 提供了服务端部署的能力，提供 Web 控制界面，可以用于在服务器等无图形界面环境下部署使用。
+
+### 镜像获取
+
+```bash
+# 拉取最新版本
+docker pull ghcr.io/xinrea/bili-shadowreplay:latest
+# 拉取指定版本
+docker pull ghcr.io/xinrea/bili-shadowreplay:2.5.0
+# 速度太慢？从镜像源拉取
+docker pull ghcr.nju.edu.cn/xinrea/bili-shadowreplay:latest
+```
+
+### 镜像使用
 
 使用方法：
 
@@ -10,7 +48,7 @@ sudo docker run -it -d\
     -v $DATA_DIR:/app/data \
     -v $CACHE_DIR:/app/cache \
     -v $OUTPUT_DIR:/app/output \
-    -v $CONFIG_FILE:/app/config.toml \
+    -v $WHISPER_MODEL:/app/whisper_model.bin \
     --name bili-shadowreplay \
     ghcr.io/xinrea/bili-shadowreplay:latest
 ```