docs: Refresh daemon developer docs#5056
Closed
doudouOUC wants to merge 1 commit into
Closed
Conversation
Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
Collaborator
|
Thanks for the PR, @doudouOUC! Template looks good ✓ — all required sections present, bilingual, linked issues. On direction: this fills a real gap. The daemon mode has grown substantially through the F1–F4 milestones and having a single comprehensive developer reference set is genuinely useful for contributors. Clearly within scope. No CHANGELOG reference needed — this is docs, not a feature. On approach: 21 new docs + 1 navigation entry + 1 deprecation notice on the existing TUI adapter draft. The scope is broad but that matches the surface area it covers. The reading-order guide and cross-reference tables are a nice touch. One thing worth flagging for maintainer discussion: the entire doc set is in Chinese while the rest of I spot-checked the numerical claims against source:
Minor numerical drift — easy fix. Moving on to code review. 🔍 中文说明感谢贡献，@doudouOUC！ 模板完整 ✓ — 所有章节齐全，双语，关联了 issue。 方向：这个 PR 填补了一个真实的文档空白。daemon 模式经过 F1–F4 里程碑已经大幅增长，有一套完整的开发者参考文档对贡献者非常有用。完全在项目范围内。 方案：21 个新文档 + 1 个导航入口 + 1 个对现有 TUI 适配器草案的过时标注。范围广但和被覆盖的功能表面积匹配。阅读顺序指南和交叉引用表做得很好。有一点值得维护者讨论：整套文档是中文，而 数值声明抽查结果：
小的数值漂移 — 容易修复。进入代码审查 🔍 — Qwen Code · qwen3.7-max |
Collaborator
Author
|
Closing this PR so the daemon documentation refresh can continue on the existing PR #4412. |
Collaborator
Code ReviewThis is a docs-only PR — 21 new markdown files under Structure & navigation: clean. The Cross-references: all relative links verified against TUI adapter deprecation notice: the edit to Content quality: the docs are thorough — Mermaid sequence diagrams for key flows, detailed middleware tables, configuration reference with env/CLI/settings.json coverage, error taxonomy, and a practical quickstart with curl verification steps. The writing is direct and implementation-aware. Numerical drift (expanding on Stage 1 findings): The The configuration table in These are easy mechanical fixes. TestingN/A — docs-only change, no runtime behavior to exercise. No tmux testing needed. 中文说明代码审查这是一个纯文档 PR — 在 结构与导航：整洁。 交叉引用：所有相对链接在 TUI 适配器过时标注：对 内容质量：文档详尽 — 关键流程有 Mermaid 时序图、详细的中间件表、覆盖 env/CLI/settings.json 的配置参考、错误分类和实用的 curl 验证快速上手指南。 数值漂移： 测试不适用 — 纯文档变更，无运行时行为可测试。 — Qwen Code · qwen3.7-max |
Collaborator
|
Stepping back: this is a genuinely useful contribution. The daemon mode has accumulated a lot of surface area across F1–F4, and having it documented in one navigable place with reading-order guides, glossary, and curl-based verification recipes is a real force multiplier for contributors. The Mermaid diagrams are clear, the cross-reference tables are thorough, and the deprecation notice on the old TUI adapter draft is the right touch. The numerical drift is the only concrete issue — capabilities off by 1 (66/10 vs claimed 65/9, missing The language question (Chinese docs in an otherwise English developers section) is worth a maintainer call — not something I'd block on, but it does create a visible inconsistency within Requesting changes for the numerical fixes — they're small but worth getting right before merge since the whole point of this doc set is to be a current reference. 中文说明退一步看：这是一个真正有用的贡献。daemon 模式经过 F1–F4 积累了大量功能表面积，把它整理成一套可导航的文档，配上阅读顺序指南、术语表和 curl 验证清单，对贡献者来说是真正的力量倍增器。 数值漂移是唯一的具体问题 — capabilities 差 1（66/10 vs 声称的 65/9，漏了 语言问题（中文文档在原本英文的 developers 章节中）值得维护者判断 — 不会因此阻塞，但确实在 因为数值修复请求修改 — 问题不大但在合入前值得修正，因为这套文档的全部目的就是提供当前有效的参考。 — Qwen Code · qwen3.7-max |
qwen-code-ci-bot
requested changes
Jun 12, 2026
qwen-code-ci-bot
left a comment
Collaborator
There was a problem hiding this comment.
Numerical drift needs a quick fix before merge — capabilities count (66/10 vs 65/9) and serve flags (24 vs 23). See review comments above for details. 🙏
Contributor
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
This PR adds the daemon developer documentation set under the Developer Guide and refreshes the existing daemon adapter draft so it matches the current
mainbranch. The documentation now covers theqwen serveruntime, ACP bridge, MCP transport pool and budget guardrails, workspace filesystem boundary, session lifecycle, typed event schema, capabilities, TypeScript SDK daemon client, shared UI transcript layer, channel and VSCode adapters, configuration, error taxonomy, observability, and quickstart operations.Why it's needed
The previous draft was written against an older daemon branch and drifted from
main: event and capability counts were stale, newer serve flags and rate-limit settings were missing, runtime MCP server mutation routes were described with an outdated path, and the legacy CLIDaemonTuiAdapterwas described as deleted even though it still exists. Bringing the docs up to date gives contributors a current reference for reviewing and extending daemon mode.Reviewer Test Plan
How to verify
Review the Developer Guide navigation and confirm the daemon section appears under
docs/developers. Check that the event schema documents 43 known daemon events, the capabilities page documents 65 feature tags and 9 conditional tags, and the configuration/quickstart pages list all 23 currentqwen serveflags. Confirm the legacyDaemonTuiAdapterlanguage says it still exists as a CLI-side legacy adapter while the SDK shared UI transcript layer is the reuse direction.Evidence (Before & After)
N/A — docs-only change.
Tested on
Environment (optional)
N/A — docs-only change. Local validation ran Prettier, staged diff whitespace checks, a source-count consistency script for daemon events/capabilities/UI event types, and a relative-link existence check.
Risk & Scope
Linked Issues
References #4412 and #4175.
中文说明
What this PR does
本 PR 在 Developer Guide 下新增 daemon 开发者文档集，并刷新既有 daemon adapter 草案，使其与当前
main分支一致。文档现在覆盖qwen serve运行时、ACP bridge、MCP transport 池与预算护栏、workspace 文件系统边界、session 生命周期、typed event schema、capabilities、TypeScript SDK daemon client、共享 UI transcript 层、channel 与 VSCode 适配器、配置、错误分类、可观测性和快速上手运维手册。Why it's needed
此前草案基于较早的 daemon 分支编写，已经和
main发生漂移：event 与 capability 数量过期，新的 serve flags 和 rate-limit 设置缺失，运行时 MCP server mutation 路由仍写成旧路径，并且把仍然存在的 legacy CLIDaemonTuiAdapter描述成已删除。更新后，贡献者在 review 和扩展 daemon mode 时能有一份当前有效的参考文档。Reviewer Test Plan
How to verify
检查 Developer Guide 导航，确认 daemon 章节出现在
docs/developers下。检查 event schema 是否记录 43 种已知 daemon event，capabilities 页面是否记录 65 个 feature tag 和 9 个条件 tag，configuration/quickstart 页面是否列出当前 23 个qwen serveflag。确认 legacyDaemonTuiAdapter的表述为它仍作为 CLI 侧 legacy adapter 存在，而 SDK 共享 UI transcript 层是复用方向。Evidence (Before & After)
N/A — 仅文档变更。
Tested on
Environment (optional)
N/A — 仅文档变更。本地验证运行了 Prettier、staged diff 空白检查、daemon event/capability/UI event type 的源码计数一致性脚本，以及相对链接存在性检查。
Risk & Scope
Linked Issues
References #4412 and #4175.