docs: 更新文档和模板文件

- 更新.env.template,移除会引起歧义的MySQL配置示例
- 更新roadmap.md,添加新功能和修复的问题
- 更新quick-start.md,修正版本号和优化代理配置说明
This commit is contained in:
Wenjie Zhang 2025-12-15 09:00:26 +08:00
parent 81d0e04586
commit a2e2756f5d
3 changed files with 11 additions and 12 deletions

View File

@ -15,14 +15,6 @@ TAVILY_API_KEY= # 获取搜索服务的 api key 请访问 https://app.tavily.co
# TOGETHER_API_KEY=
# # endregion model_provider
# # 数据库基础配置示例
# MYSQL_HOST=192.168.1.100
# MYSQL_USER=username
# MYSQL_PASSWORD=your_secure_password
# MYSQL_DATABASE=database_name
# MYSQL_PORT=3306
# MYSQL_CHARSET=utf8mb4
# # region neo4j
# NEO4J_URI=
# NEO4J_USERNAME=

View File

@ -38,11 +38,13 @@
- 新增暗色模式支持并调整整体 UI[#343](https://github.com/xerrors/Yuxi-Know/pull/343)
- agent 状态中的文件区域,新增可以下载
- 移除 Chroma 的支持,当前版本标记为移除
- 新增知识库评估功能支持导入评估基准或者自动构建评估基准目前仅支持Milvus类型知识库
### 修复
- 修复重排序模型实际未生效的问题
- 修复消息中断后消息消失的问题,并改善异常效果
- 修复当前版本如果调用结果为空的时候,工具调用状态会一直处于调用状态,尽管调用是成功的
- 修复检索配置实际未生效的问题
## v0.3

View File

@ -16,13 +16,13 @@
```bash
# 克隆稳定版本
git clone --branch v0.3.0 --depth 1 https://github.com/xerrors/Yuxi-Know.git
git clone --branch v0.3.6-beta --depth 1 https://github.com/xerrors/Yuxi-Know.git
cd Yuxi-Know
```
::: warning 版本说明
- `v0.3.0`: 稳定版本
- `v0.3.5-beta`:最新的 Beta 测试版
- `v0.3.6-beta`:最新的 Beta 测试版
- `main`: 最新开发版本(不稳定,新特性可能会导致新 bug
:::
@ -97,10 +97,10 @@ bash docker/pull_image.sh python:3.12-slim
powershell -ExecutionPolicy Bypass -File docker/pull_image.ps1 python:3.12-slim
```
**离线部署方案**
**离线镜像拉取方案**
```bash
# 在有网络的环境保存镜像
# 在有网络的环境保存镜像(镜像名称需要确认是否和实际一致)
bash docker/save_docker_images.sh # Linux/macOS
powershell -ExecutionPolicy Bypass -File docker/save_docker_images.ps1 # Windows
@ -119,8 +119,13 @@ docker load -i docker_images_xxx.tar
如果构建失败,通常是网络问题,可以配置代理:
```bash
# Linux / macOS
export HTTP_PROXY=http://IP:PORT
export HTTPS_PROXY=http://IP:PORT
# Windows PowerShell
$env:HTTP_PROXY="http://IP:PORT"
$env:HTTPS_PROXY="http://IP:PORT"
```
如果已配置代理但构建失败,尝试移除代理后重试。