Skip to content

docs: document extension contracts and agent deploy flows (#172, #145)#173

Merged
liujuanjuan1984 merged 4 commits intomainfrom
docs/issue-172-extension-contract-docs
Mar 13, 2026
Merged

docs: document extension contracts and agent deploy flows (#172, #145)#173
liujuanjuan1984 merged 4 commits intomainfrom
docs/issue-172-extension-contract-docs

Conversation

@liujuanjuan1984
Copy link
Collaborator

@liujuanjuan1984 liujuanjuan1984 commented Mar 13, 2026

背景

本 PR 当前包含两组文档收敛:

  • #172:补齐共享扩展契约的文档可发现性
  • #145:发布面向消费方 agent 的自部署 / 释放 SOP,并明确 deploy.shdeploy_light.sh 的适用边界

本次变更仍然聚焦文档层,不引入运行时代码逻辑修改。

模块变更

README.md

  • 新增 Extension Capability Overview 作为能力展示入口,集中说明 6 个 extension URI 的 shared/private 边界与主要用途
  • 补充 docs/agent_deploy_sop.md 的入口,便于从仓库首页直接定位部署 SOP
  • 调整 Documentation Map 文案,使 README 负责展示层,详细消费/操作说明下沉到对应文档

docs/guide.md

  • 将扩展能力总览收敛为消费导向说明,明确区分 Agent Card capability declaration 与运行时 shared metadata
  • 将原有会话继续说明提升为正式的 Shared Session Binding Contract 专章
  • 新增 Shared Stream Hints Contract 专章
  • Shared Model Selection Contract 中补充 capability URI,保持 shared contract 表达一致

docs/agent_deploy_sop.md

  • 将原中文 draft 升级为正式英文 SOP
  • 同步项目名为 opencode-a2a-server
  • 明确区分两条启动路径:
    • deploy.sh:systemd、多实例、生产导向
    • deploy_light.sh:当前用户、轻量、本地/自托管导向
  • 单独说明 ENABLE_SECRET_PERSISTENCE=false 的安全默认两步流程,与 ENABLE_SECRET_PERSISTENCE=true 的显式落盘模式
  • 为两条路径分别补充启动、校验、释放方式

scripts/README.md

  • 增加 deploy SOP 的索引入口,补齐脚本文档与操作 SOP 的导航关系

.gitignore

  • 增加 run/,避免本地运行产物持续污染工作区

相关 Commits

  • docs(guide): document shared extension capability contracts (#172)
  • docs(readme): surface extension capability overview (#172)
  • docs(sop): draft zh-cn agent self-deploy and release guide #145
  • docs(sop): publish agent self-deploy and release SOP (#145)

关联 Issues

验证

uv run pre-commit run --files .gitignore README.md docs/guide.md
uv run pre-commit run --files docs/agent_deploy_sop.md README.md scripts/README.md
uv run pytest

结果:

  • pre-commit 通过
  • pytest 167 项通过,coverage 84.48%

@liujuanjuan1984 liujuanjuan1984 changed the title docs(guide): document shared extension capability contracts (#172) docs(contracts): surface extension capability overview (#172) Mar 13, 2026
@liujuanjuan1984 liujuanjuan1984 changed the title docs(contracts): surface extension capability overview (#172) docs: document extension contracts and agent deploy flows (#172, #145) Mar 13, 2026
@liujuanjuan1984
Copy link
Collaborator Author

当前 Draft PR 已具备转入人工评审的条件,供后续人工执行 Ready for review 时参考:

  • #172 已完成:共享扩展契约文档补齐,README 能力展示与 guide 消费说明已收敛
  • #145 的本次文档范围已完成:英文 SOP、项目改名同步、deploy.sh / deploy_light.sh 区分、ENABLE_SECRET_PERSISTENCE 说明补齐
  • 本 PR 不包含运行时代码逻辑修改,仅为 docs 变更
  • 已完成验证:
    • uv run pre-commit run --files .gitignore README.md docs/guide.md
    • uv run pre-commit run --files docs/agent_deploy_sop.md README.md scripts/README.md
    • uv run pytest
  • 当前 CI 已通过

说明:根据仓库协作约束,Draft -> Ready for Review 仍应由人类手动执行。

@liujuanjuan1984 liujuanjuan1984 marked this pull request as ready for review March 13, 2026 11:33
@liujuanjuan1984 liujuanjuan1984 merged commit 968cc15 into main Mar 13, 2026
3 checks passed
@liujuanjuan1984 liujuanjuan1984 deleted the docs/issue-172-extension-contract-docs branch March 13, 2026 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Priority: Med] [docs] 补齐 shared session-binding 与 stream-hints 扩展消费文档

1 participant