Skip to content

Commit a2e2756

Browse files
committed
docs: 更新文档和模板文件
- 更新.env.template,移除会引起歧义的MySQL配置示例 - 更新roadmap.md,添加新功能和修复的问题 - 更新quick-start.md,修正版本号和优化代理配置说明
1 parent 81d0e04 commit a2e2756

File tree

3 files changed

+11
-12
lines changed

3 files changed

+11
-12
lines changed

.env.template

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,6 @@ TAVILY_API_KEY= # 获取搜索服务的 api key 请访问 https://app.tavily.co
1515
# TOGETHER_API_KEY=
1616
# # endregion model_provider
1717

18-
# # 数据库基础配置示例
19-
# MYSQL_HOST=192.168.1.100
20-
# MYSQL_USER=username
21-
# MYSQL_PASSWORD=your_secure_password
22-
# MYSQL_DATABASE=database_name
23-
# MYSQL_PORT=3306
24-
# MYSQL_CHARSET=utf8mb4
25-
2618
# # region neo4j
2719
# NEO4J_URI=
2820
# NEO4J_USERNAME=

docs/latest/changelog/roadmap.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,13 @@
3838
- 新增暗色模式支持并调整整体 UI([#343](https://github.com/xerrors/Yuxi-Know/pull/343)
3939
- agent 状态中的文件区域,新增可以下载
4040
- 移除 Chroma 的支持,当前版本标记为移除
41+
- 新增知识库评估功能,支持导入评估基准或者自动构建评估基准(目前仅支持Milvus类型知识库)
4142

4243
### 修复
4344
- 修复重排序模型实际未生效的问题
4445
- 修复消息中断后消息消失的问题,并改善异常效果
4546
- 修复当前版本如果调用结果为空的时候,工具调用状态会一直处于调用状态,尽管调用是成功的
47+
- 修复检索配置实际未生效的问题
4648

4749

4850
## v0.3

docs/latest/intro/quick-start.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@
1616

1717
```bash
1818
# 克隆稳定版本
19-
git clone --branch v0.3.0 --depth 1 https://github.com/xerrors/Yuxi-Know.git
19+
git clone --branch v0.3.6-beta --depth 1 https://github.com/xerrors/Yuxi-Know.git
2020
cd Yuxi-Know
2121
```
2222

2323
::: warning 版本说明
2424
- `v0.3.0`: 稳定版本
25-
- `v0.3.5-beta`:最新的 Beta 测试版
25+
- `v0.3.6-beta`:最新的 Beta 测试版
2626
- `main`: 最新开发版本(不稳定,新特性可能会导致新 bug)
2727
:::
2828

@@ -97,10 +97,10 @@ bash docker/pull_image.sh python:3.12-slim
9797
powershell -ExecutionPolicy Bypass -File docker/pull_image.ps1 python:3.12-slim
9898
```
9999

100-
**离线部署方案**
100+
**离线镜像拉取方案**
101101

102102
```bash
103-
# 在有网络的环境保存镜像
103+
# 在有网络的环境保存镜像(镜像名称需要确认是否和实际一致)
104104
bash docker/save_docker_images.sh # Linux/macOS
105105
powershell -ExecutionPolicy Bypass -File docker/save_docker_images.ps1 # Windows
106106

@@ -119,8 +119,13 @@ docker load -i docker_images_xxx.tar
119119
如果构建失败,通常是网络问题,可以配置代理:
120120

121121
```bash
122+
# Linux / macOS
122123
export HTTP_PROXY=http://IP:PORT
123124
export HTTPS_PROXY=http://IP:PORT
125+
126+
# Windows PowerShell
127+
$env:HTTP_PROXY="http://IP:PORT"
128+
$env:HTTPS_PROXY="http://IP:PORT"
124129
```
125130

126131
如果已配置代理但构建失败,尝试移除代理后重试。

0 commit comments

Comments
 (0)