docs: refresh settings, MCP glob, auth alias, and autonomous loop docs - #6090
Conversation
Audit docs/ against the current codebase and correct user-facing drift: - Document glob-pattern support (* and ?) for mcp.allowed / mcp.excluded in settings.md and the MCP feature page (feat #6012). - Add missing user-facing settings rows: general.terminalBell, general.preventSystemSleep, general.chatRecording; ui.showStatusInTitle, ui.disableWorkflowKeywordTrigger, ui.enableUserFeedback, ui.compactInline, ui.useTerminalBuffer, ui.hideBuiltinWorktreeIndicator; memory.enableTeamMemory, memory.enableTeamMemorySync; tools.toolSearch.enabled. - Note the QWEN_MODEL alias for OPENAI_MODEL in the auth protocol table. - Document the autonomous (bare /loop) mode in scheduled-tasks (feat #5991).
|
Thanks for the PR! Template looks good ✓ On direction: straightforward docs maintenance — closing the gap between shipped features and their documentation. Clearly aligned with the project's needs. Settings, MCP glob support, auth alias, and autonomous On approach: the scope is tight and appropriate. Four doc files, each change traceable to a specific code source. No scope creep, no drive-by refactors. The PR description is unusually well-sourced — every claim names the exact file and function. Refreshing. I verified each claim against the codebase:
Moving on to code review. 🔍 中文说明感谢贡献! 模板完整 ✓ 方向:标准的文档维护——补齐已发布功能与文档之间的差距。明确符合项目需求。Settings、MCP glob 支持、auth 别名和自动 方案:范围紧凑且恰当。四个文档文件,每处改动都可追溯到具体的代码来源。没有范围蔓延,没有顺手重构。PR 描述异常详尽——每个声明都指明了具体的文件和函数。令人耳目一新。 已对照代码库逐项验证:
进入代码审查 🔍 — Qwen Code · qwen3.7-max |
Code reviewIndependent proposal (before reading the diff): given the title, I would have done the same four edits — add missing settings rows to No correctness issues found. Specific observations:
No blockers, no AGENTS.md violations. This is clean docs work. Real-scenario testingDocs-only PR — no TUI or behavioral changes. N/A for tmux testing. Markdown formatting verified against the existing table structures in the source files. 中文说明代码审查独立方案(阅读 diff 前):根据标题,我会做同样的四处修改——在 未发现正确性问题。具体观察:
无阻塞问题,无 AGENTS.md 违规。干净的文档工作。 真实场景测试纯文档 PR —— 无 TUI 或行为变更,tmux 测试不适用。Markdown 格式已对照源文件中的现有表格结构验证。 — Qwen Code · qwen3.7-max |
|
This is a clean, well-sourced docs refresh. Every claim was verified against the codebase — settings keys, defaults, types, descriptions all match My independent proposal matched the PR exactly. No simpler path was missed. The diff carries no unrelated changes — four files, each edit purposeful. Approving. ✅ 中文说明这是一次干净、有据可查的文档刷新。每项声明都已对照代码库验证——设置项键名、默认值、类型和描述均与 我的独立方案与 PR 完全一致,没有遗漏更简路径。diff 中无无关改动——四个文件,每处编辑都有明确目的。 批准 ✅ — Qwen Code · qwen3.7-max |
qwen-code-ci-bot
left a comment
There was a problem hiding this comment.
LGTM, looks ready to ship. ✅
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. |
What this PR does
Audits the user documentation under
docs/users/against the current codebase and corrects user-facing drift, without touching source code or README files. Specifically: documents glob-pattern support for themcp.allowed/mcp.excludedserver lists in both the settings reference and the MCP feature page; adds twelve missing user-facing settings rows toconfiguration/settings.md(threegeneral.*, sixui.*, twomemory.*, andtools.toolSearch.enabled); notes theQWEN_MODELalias for theOPENAI_MODELenvironment variable in the auth protocol table; and documents the autonomous (bare/loop) mode on the scheduled-tasks page.Why it's needed
Several shipped features and settings drifted out of the docs.
mcp.allowed/mcp.excludedgained glob matching (*,?) in #6012 but the docs still described them as plain exact-name lists. The settings reference was missing settings that are surfaced in the in-app Settings dialog (e.g.general.terminalBell,general.preventSystemSleep,ui.showStatusInTitle,ui.useTerminalBuffer,tools.toolSearch.enabled) and other configurable keys with important caveats (general.chatRecordingdisables--continue/--resume; thememory.enableTeamMemory*team-memory tier). The OpenAI-compatible auth type also acceptsQWEN_MODELas a model env var (AUTH_ENV_MAPPINGS.openai.model = ['OPENAI_MODEL', 'QWEN_MODEL']), which was undocumented. Finally, a bare/loopnow starts an autonomous "keep the work moving" mode (#5991) that had no user documentation. Each change is backed by the current schema/code as the source of truth.Reviewer Test Plan
How to verify
Docs-only change. To confirm accuracy against the source of truth:
mcp.allowed/mcp.excludedglob support:packages/core/src/config/config.ts(matchesServerPattern/matchesAnyServerPattern) and its tests inconfig.test.ts(e.g.*puppeteer*matchesmy-puppeteer-server); schema descriptions inpackages/cli/src/config/settingsSchema.ts(A list of MCP servers to allow. Supports glob patterns...).packages/cli/src/config/settingsSchema.ts(terminalBell,preventSystemSleep,chatRecording,showStatusInTitle,disableWorkflowKeywordTrigger,enableUserFeedback,compactInline,useTerminalBuffer,hideBuiltinWorktreeIndicator,enableTeamMemory,enableTeamMemorySync,toolSearch.enabled).QWEN_MODELalias:packages/core/src/models/constants.ts(AUTH_ENV_MAPPINGS.openai.model)./loop:packages/core/src/skills/bundled/loop/SKILL.md(empty-input autonomous path).No new pages were added, moved, or renamed, so
_meta.tsnavigation and theqc-helperbundled doc index need no updates.Evidence (Before & After)
N/A (docs-only).
Tested on
Environment (optional)
N/A
Risk & Scope
model.baseUrl,model.sessionTokenLimit,visionModel,voiceModel,security.auth.apiKey/baseUrl,/model --vision, and--safe-mode; those are intentionally not duplicated here. The auth, model-providers, quickstart, and slash-command docs were audited and found accurate (no changes needed).Linked Issues
N/A
中文说明
本 PR 的内容
针对当前代码库审计
docs/users/下的用户文档,修正面向用户的文档偏差,不改动源代码或 README。具体包括:在设置参考和 MCP 功能页中补充mcp.allowed/mcp.excluded服务器列表的通配符(glob)匹配支持;在configuration/settings.md中补齐十二个缺失的用户可见设置项(三个general.*、六个ui.*、两个memory.*,以及tools.toolSearch.enabled);在鉴权协议表中标注OPENAI_MODEL环境变量的别名QWEN_MODEL;并在计划任务页中补充自动(裸/loop)模式的说明。为什么需要
部分已发布的功能和设置与文档脱节。
mcp.allowed/mcp.excluded在 #6012 中获得了通配符(*、?)匹配,但文档仍将其描述为精确名称列表。设置参考缺少了在应用内设置对话框中可见的设置项(如general.terminalBell、general.preventSystemSleep、ui.showStatusInTitle、ui.useTerminalBuffer、tools.toolSearch.enabled),以及带有重要注意事项的其他可配置项(general.chatRecording关闭后会使--continue/--resume失效;memory.enableTeamMemory*团队记忆层)。OpenAI 兼容鉴权类型还接受QWEN_MODEL作为模型环境变量(AUTH_ENV_MAPPINGS.openai.model = ['OPENAI_MODEL', 'QWEN_MODEL']),此前未记录。最后,裸/loop现在会启动自动「持续推进工作」模式(#5991),此前没有用户文档。每处改动均以当前的 schema/代码作为权威来源。复核测试计划
如何验证
仅文档改动。可对照权威来源核对准确性:
mcp.allowed/mcp.excluded通配符支持:packages/core/src/config/config.ts(matchesServerPattern/matchesAnyServerPattern)及config.test.ts测试(如*puppeteer*匹配my-puppeteer-server);packages/cli/src/config/settingsSchema.ts中的 schema 描述。packages/cli/src/config/settingsSchema.ts中的定义。QWEN_MODEL别名:packages/core/src/models/constants.ts(AUTH_ENV_MAPPINGS.openai.model)。/loop:packages/core/src/skills/bundled/loop/SKILL.md(空输入的自动路径)。未新增、移动或重命名任何页面,因此
_meta.ts导航和qc-helper文档索引无需更新。证据(前后对比)
N/A(仅文档)。
测试平台
运行环境(可选)
N/A
风险与范围
model.baseUrl、model.sessionTokenLimit、visionModel、voiceModel、security.auth.apiKey/baseUrl、/model --vision和--safe-mode,此处不重复。auth、model-providers、quickstart 和斜杠命令文档已审计,确认准确(无需改动)。关联 Issue
N/A
Generated by Claude Code