Skip to content

fix(docs): update config file references from example to full #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yaozheng-fang merged 1 commit into from
Sep 6, 2025
Merged

fix(docs): update config file references from example to full #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Run python `deploy.py` for deployment on Volcengine FaaS platform.

```bash
└── veadk-cloud-proj
├── config.yaml.example # 定义环境变量
├── config.yaml.full # 定义环境变量
├── deploy.py # 部署脚本
└── src
├── agent.py # agent 运行时数据导出
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ uv pip install -e .

## 配置

VeADK 在仓库中提供了一个示例配置文件`config.yaml.example`，其中标明了一个智能体运行的必需（required）配置和可选（optional）配置。您可以基于该示例文件，在项目根目录下创建实际使用的配置文件`config.yaml`。VeADK 中的配置模块将自动查找并加载该文件内容，并将其中的配置项映射为运行时环境变量，从而帮助您省去环境配置的时间。
VeADK 在仓库中提供了一个示例配置文件`config.yaml.full`，其中标明了一个智能体运行的必需（required）配置和可选（optional）配置。您可以基于该示例文件，在项目根目录下创建实际使用的配置文件`config.yaml`。VeADK 中的配置模块将自动查找并加载该文件内容，并将其中的配置项映射为运行时环境变量，从而帮助您省去环境配置的时间。

完整的配置项可以参考[`config.yaml.example`文件](https://github.com/volcengine/veadk-python/blob/main/config.yaml.example)。
完整的配置项可以参考[`config.yaml.full`文件](https://github.com/volcengine/veadk-python/blob/main/config.yaml.full)。

### 说明

Expand Down