[新增] 更新文档

This commit is contained in:
ryan
2026-05-28 22:50:24 +08:00
parent b69bdf838d
commit 5a0821274b
31 changed files with 2418 additions and 256 deletions
+11 -1
View File
@@ -20,6 +20,13 @@
6. [docs/reference/configuration.md](./docs/reference/configuration.md)
作用:理解系统启动时支持的环境变量、命令行参数、运行时配置项和 Agent 配置字段。
如任务涉及用户文档、贡献者入口或排障体验,还应阅读:
* [docs/guide/quick-start.md](./docs/guide/quick-start.md):理解新用户从 0 到运行的最短路径。
* [docs/guide/usage.md](./docs/guide/usage.md):理解网站配置、证书、发布、回滚和观测的基础用法。
* [docs/guide/development.md](./docs/guide/development.md):理解本地开发、测试和构建命令。
* [docs/guide/troubleshooting.md](./docs/guide/troubleshooting.md):理解常见失败症状与排查路径。
线上文档入口:https://open-flare.pages.dev
## 执行要求
@@ -37,5 +44,8 @@
* 系统结构、模块职责变化:更新 `docs/design/architecture.md`
* 发布、同步、回滚模型变化:更新 `docs/design/release-model.md`
* 开发约束、代码规范、接口约定、阶段原则、测试基线变化:更新 `docs/design/development.md`
* 产品启动、部署、升级、联调方式变化:更新 `docs/guide/deployment.md` 和 `README.md`
* 产品启动、部署、升级、联调方式变化:更新 `docs/guide/quick-start.md`、`docs/guide/deployment.md` 和 `README.md`
* 用户操作路径、常见场景变化:更新 `docs/guide/usage.md`
* 本地开发、测试、构建方式变化:更新 `docs/guide/development.md`
* 常见故障、排查路径变化:更新 `docs/guide/troubleshooting.md`
* 环境变量、命令行参数、运行时配置、Agent 配置变化:更新 `docs/reference/configuration.md`