docs: add vertex-ai auth, missing commands, and qc-helper index entries#5727
Open
DragonnZhang wants to merge 12 commits into
Open
docs: add vertex-ai auth, missing commands, and qc-helper index entries#5727DragonnZhang wants to merge 12 commits into
DragonnZhang wants to merge 12 commits into
Conversation
- Add section 5 to commands.md for CLI-level subcommands - Document qwen sessions list with --json and --limit flags - Include output format, examples, and usage patterns The sessions list command was added in commit 14e6ae8 but not documented.
Audit docs/ against current codebase and fix high-impact drift: - Add vertex-ai to auth.md, model-providers.md, and tos-privacy.md supported auth type tables (was missing from all three) - Add missing slash commands to commands.md: /cd, /import-config, /workflows - Add /doctor subcommands (memory, cpu-profile, rollback) and /extensions subcommands (list, manage, explore, install) to commands.md - Add undocumented altNames: /clear→/reset,/new; /stats→/usage; /auth→/connect,/login; /resume→/continue; /compress→/summarize - Add 8 missing feature entries to qc-helper SKILL.md topic index: code-review, followup-suggestions, tool-use-summaries, markdown-rendering, structured-output, dual-output, channels, tips - Fix CLI binary name in contributing.md (qwen-code → qwen)
Collaborator
|
Thanks for the PR! Template looks good ✓ On direction: documentation drift fixes are essential maintenance — users can't discover features that aren't documented. Vertex AI auth has first-class code support but was invisible in docs, three slash commands were registered but undocumented, and eight feature pages were unreachable via On approach: scope is tight and well-justified. Each change maps to a specific, verifiable gap between code and docs. The "out of scope" note on settings.md backlog shows good discipline — flagged but not bloated into this PR. Six files, +144/-42, no drive-by refactors. Moving on to code review. 🔍 中文说明感谢贡献！ 模板完整 ✓ 方向：文档偏差修复是开发者工具的核心维护工作。Vertex AI 认证在代码中有一等支持但文档中完全缺失，三个斜杠命令已注册但未文档化，八个功能页面无法通过 方案：范围紧凑且理由充分。每个改动都对应代码与文档之间可验证的具体缺口。"超出范围"中关于 settings.md 积压的处理体现了良好的纪律——标记但不膨胀本 PR。6 个文件，+144/-42，无顺手重构。 进入代码审查 🔍 — Qwen Code · qwen3.7-max |
Collaborator
Code ReviewDocs-only PR, six files. Verified every code-backed claim in the diff:
No correctness bugs, no stale references, no overreach. The diff is tight — every line maps to a verified gap. Real-Scenario TestingN/A — documentation changes only. No behavioral change to test via tmux. 中文说明代码审查纯文档 PR，6 个文件。已逐一验证 diff 中所有代码相关的声明：
无正确性错误，无过时引用，无越界改动。 实际场景测试N/A — 仅文档更改，无行为变更需要通过 tmux 测试。 — Qwen Code · qwen3.7-max |
Collaborator
|
Clean docs PR — audit-driven, tightly scoped, every change verified against the codebase. The Vertex AI auth gap, missing commands, and unreachable qc-helper index entries are all real problems users would hit. No overreach, no drive-by edits. Ships what it says. Approving. ✅ 中文说明干净的文档 PR——基于审计驱动，范围紧凑，每项改动均已对照代码库验证。Vertex AI 认证文档缺口、缺失的命令文档、以及 批准。✅ — Qwen Code · qwen3.7-max |
qwen-code-ci-bot
previously approved these changes
Jun 23, 2026
qwen-code-ci-bot
left a comment
qwen-code-ci-bot
left a comment
Collaborator
There was a problem hiding this comment.
LGTM, looks ready to ship. ✅
Collaborator
Author
|
@copilot help me solve merge conflict |
auto-merge was automatically disabled
June 23, 2026 01:53
Head branch was pushed to by a user without write access
Contributor
Conflict is resolved by merging |
…_MODEL example - auth.md: correct intro count from 'four' to 'three' methods (3 bullets + 3 Options; Vertex AI is a provider under API Key) - commands.md: add '/workflows <runId>' to usage column to match argumentHint '[runId]' - model-providers.md: add required GOOGLE_MODEL to the Vertex AI env example so it matches the prose and modelConfigUtils requirement
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. |
main already documents /workflows (with the <runId> usage); the branch merge kept both rows, leaving a duplicate in the Tool and Model Management table. Drop the redundant row added by this PR.
qwen-code-ci-bot
left a comment
qwen-code-ci-bot
left a comment
Collaborator
There was a problem hiding this comment.
No review findings. Downgraded from Approve to Comment: CI still running.
Verified every code-backed claim in the diff:
- Vertex AI auth:
AuthType.USE_VERTEX_AIconfirmed inpackages/core/src/models/constants.tswith the documented env vars (GOOGLE_API_KEY,GOOGLE_MODEL).@google/genaiSDK is the correct choice (same SDK as Gemini, withvertexai: trueplumbed throughgeminiContentGenerator). - Supported protocols table:
vertex-airow with the documented env vars matches the code'sAuthEnvMapping. - Commands:
/cd,/import-config,/workflowsall registered; altNames/reset,/new,/continue,/summarize,/usage,/connect,/loginconfirmed inclearCommand.ts,compressCommand.ts,resumeCommand.ts,authCommand.ts,statsCommand.ts. Subcommands for/doctor(memory,cpu-profile,rollback) and/extensions(list,manage,explore,install) match their respective command files. - qc-helper index: all 8 added doc paths (
code-review,followup-suggestions,tool-use-summaries,markdown-rendering,structured-output,dual-output,channels/overview,tips) exist underdocs/users/features/. - CLI binary name:
package.jsonbin field confirmsqwen, so theqwen-code→qwenfix incontributing.mdis correct. - ToS/privacy: "four authentication methods" with a Vertex AI row is consistent with the codebase.
Clean, tightly-scoped docs PR. LGTM ✅
— qwen3.7-max via Qwen Code /review
…rtex-ai-commands # Conflicts: # docs/users/configuration/auth.md # docs/users/features/commands.md # packages/core/src/skills/bundled/qc-helper/SKILL.md
…ame remnants - commands.md: /extensions explore requires a <source> (exploreAction errors 'Unknown extensions source' without it) - contributing.md: finish the qwen-code -> qwen CLI rename on the debug note (binary + .qwen config dir); repo-name references left intact
…lback clarity - tos-privacy.md: propagate Vertex AI (which the header already counts as the 4th method) into the Data Collection list, FAQ Q1 and Q3, and add a '4. If you are using Vertex AI' section pointing to Google Cloud terms — fixes the four-vs-three internal inconsistency - commands.md: clarify /doctor rollback rolls back the standalone CLI binary (standalone installs only) and disambiguate from /rewind's rollback alias (doctorCommand.ts gates on isStandalone)
…ow spacing - /clear: fix description to 'Clear conversation history and free up context' and drop the misleading '(shortcut: Ctrl+L)' grouping; Ctrl+L only clears the screen (clearScreen), it does not reset the session like /clear (clearCommand.ts) - Ctrl/cmd+L keyboard row: clarify it clears the visible screen only, not 'Equivalent to /clear' - /doctor memory and /doctor cpu-profile: surface the full argumentHints ([--sample] [--snapshot], [--duration <seconds>]) from doctorCommand.ts - normalize section 1.4 arrow subcommands to spaced '→ ' style (approval-mode rows were the lone outliers)
Collaborator
|
Qwen Code review did not complete successfully: Qwen review aborted with an API error before posting comments. See workflow logs. |
List the two valid sources (Gemini, ClaudeCode) from EXTENSION_EXPLORE_URL in extensionsCommand.ts so users can discover them without trial and error.
/extensions install (extensionsCommand.ts) installs arbitrary git repos/paths with no confirmation prompt; add a warning that extensions run with full Qwen Code permissions and should only come from trusted sources.
qwen-code-ci-bot
left a comment
qwen-code-ci-bot
left a comment
Collaborator
There was a problem hiding this comment.
Also noting: the root CONTRIBUTING.md (not modified by this PR) still uses the old qwen-code CLI binary name and .qwen-code/.env path in lines 109, 125, 270, and 273 — these should be updated to qwen and .qwen/.env for consistency with the docs/developers/contributing.md changes in this PR.
— qwen3.7-max via Qwen Code /review
… in 1.11 - commands.md: add /stats daily, /stats monthly, /stats export rows (registered in statsCommand.ts with day/month aliases and --format csv|json) - section 1.11: note /auth's /connect and /login aliases (parallel to section 1.4)
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
Audit
docs/against the current codebase and fix high-impact documentation drift across six files.Authentication docs: The
vertex-aiauth type existed in code (AuthType.USE_VERTEX_AI,packages/core/src/models/constants.ts) but was entirely absent fromauth.md,model-providers.md, andtos-privacy.md. All three said "three authentication methods" when the code supports four. Addedvertex-airows to the supported protocols tables, env var examples, multi-provider JSON examples, SDK tables, and the ToS/privacy table.Commands reference: Three top-level slash commands (
/cd,/import-config,/workflows) were registered inBuiltinCommandLoader.tsbut missing fromcommands.md. Six subcommands (/doctor memory|cpu-profile|rollback,/extensions list|manage|explore|install) were also missing. Five alternate command names (/reset,/new,/usage,/connect,/login,/continue,/summarize) existed in code but were undocumented.qc-helper skill index: Eight feature pages existed in
docs/users/features/but were not listed in the bundledqc-helperSKILL.md topic-to-path table, making them undiscoverable at runtime via/qc-helper. Added entries for: code-review, followup-suggestions, tool-use-summaries, markdown-rendering, structured-output, dual-output, channels, and tips.Developer docs:
contributing.mdusedqwen-codeas the CLI binary name in two places; the actual binary isqwen.Why it's needed
Users reading the auth docs cannot discover the Vertex AI auth type despite full first-class support in the codebase. Users browsing
/helpor the commands reference cannot find/cd,/import-config, or/workflows. The/qc-helperskill cannot route questions to 8 existing feature pages because they're missing from its topic index. These are the highest-impact gaps found by a systematic audit ofdocs/against the implementation.Reviewer Test Plan
How to verify
auth.mdsupported protocols table — should listvertex-aiwithGOOGLE_API_KEY,GOOGLE_MODELmodel-providers.md— should have avertex-airow in the auth types table and SDK table, plus a dedicated section with a JSON examplecommands.md— search for/cd,/import-config,/workflows,/doctor cpu-profile,/doctor rollback,/extensions listqc-helper/SKILL.mdFeatures table — should have 25 entries (was 17, added 8)contributing.mdline 99 and 115 — should sayqwennotqwen-codeas the CLI binarytos-privacy.md— should say "four authentication methods" with a Vertex AI rowEvidence (Before & After)
N/A — documentation changes only.
Tested on
Risk & Scope
Linked Issues
N/A — audit-driven refresh.
中文说明
此 PR 的作用
对
docs/目录进行审计，修复跨六个文件的高影响文档偏差。认证文档：
vertex-ai认证类型在代码中存在（AuthType.USE_VERTEX_AI），但在auth.md、model-providers.md和tos-privacy.md中完全缺失。三个文件都写的是"三种认证方式"，而代码实际支持四种。命令参考： 三个顶层斜杠命令（
/cd、/import-config、/workflows）在代码中已注册但文档中缺失。六个子命令和五个别名命令也未记录。qc-helper 技能索引： 8 个功能页面存在于
docs/users/features/中但未在qc-helperSKILL.md 的主题路径表中列出。开发者文档：
contributing.md中两处将 CLI 二进制名称错误地写为qwen-code，实际应为qwen。为什么需要此更改
用户无法通过文档发现 Vertex AI 认证类型、多个已实现的斜杠命令，以及 8 个已有的功能页面。此 PR 通过系统性审计修复了这些高影响的文档缺口。