fix(core): fix qc-helper skill docs index and config categories#4848
Conversation
- Remove broken memory.md entry (file lives in features/, not configuration/) - Add missing doc entries: hooks, auto-mode, status-line, scheduled-tasks, worktree - Extract hooks from the 'Advanced' bucket into its own config category row with a proper reference to docs/features/hooks.md (1300-line comprehensive doc) - Add auto-mode.md reference to the Tool Approval config category This ensures the qc-helper bundled skill can locate the correct documentation when answering user questions about configuration, hooks, and features.
qwen-code-ci-bot
left a comment
There was a problem hiding this comment.
No review findings. Downgraded from Approve to Comment: CI checks are still pending.
All doc paths verified correct — the broken docs/configuration/memory.md fix, the five new feature entries, and the Hooks promotion to its own config category are all sound. LGTM. ✅
— qwen3.7-max via Qwen Code /review
|
Thanks for the PR! Template looks good ✓ On direction: this is a straightforward docs-index fix for the On approach: scope is tight — one file, three categories of fix (broken path, missing entries, promoted category). The paths all resolve correctly through the build-time copy / dev-time symlink mechanism that maps Moving on to code review. 🔍 中文说明感谢贡献! 模板完整 ✓ 方向:这是对 方案:范围紧凑——一个文件,三类修复(错误路径、缺失条目、提升分类)。所有路径通过构建时复制/开发时符号链接机制(将 进入代码审查 🔍 — Qwen Code · qwen3.7-max |
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. |
qwen-code-ci-bot
left a comment
There was a problem hiding this comment.
Downgraded from Approve to Comment: CI failing (triage). No review blockers found. Minor suggestions below and in inline comments.
[Suggestion] Several feature doc files under docs/users/features/ exist but remain unindexed in this table — notably code-review.md (covers /review, one of the most used bundled skills). Lower priority: structured-output.md, dual-output.md, followup-suggestions.md, markdown-rendering.md, tips.md, tool-use-summaries.md, and channels/. Acknowledging this is explicitly out of scope per the PR description.
— qwen3.7-max via Qwen Code /review
DragonnZhang
left a comment
There was a problem hiding this comment.
Review Summary
Verdict: Approve (non-blocking observation below)
Verification performed
-
Broken path fix — Confirmed
docs/configuration/memory.mddoes NOT exist in the builtdist/bundled/qc-helper/tree, whiledocs/features/memory.mddoes. Correct fix. -
New feature entries — All 5 newly indexed paths verified to exist:
docs/features/auto-mode.mddocs/features/hooks.mddocs/features/status-line.mddocs/features/scheduled-tasks.mddocs/features/worktree.md
-
Config categories table — The extraction of
hooksfrom the Advanced bucket into its own row is correct. Verified thatsettings.mddoes not mention hooks at all, so referencing onlydocs/features/hooks.md(withoutsettings.md) is accurate. The addition ofauto-mode.mdto the Tool Approval row is appropriate sincetools.approvalModeinsettings.mdlists the approval modes andauto-mode.mdprovides the deep-dive reference. -
Hooks doc size — Confirmed 1306 lines, matching the PR description claim of ~1300 lines.
-
Table formatting — Column widths are consistent and properly aligned throughout.
Observation (non-blocking)
Seven feature docs remain unindexed in the Features table after this PR:
code-review.mddual-output.mdfollowup-suggestions.mdmarkdown-rendering.mdstructured-output.mdtips.mdtool-use-summaries.md
The channels/ subdirectory (6 docs: dingtalk, feishu, overview, plugins, telegram, weixin) is also unindexed. These are explicitly out of scope per the PR description, but worth tracking in a follow-up to ensure /qc-helper can discover them.
Consistency: every other Common Config Category row with a feature doc also references docs/configuration/settings.md; add it to the Hooks row too. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Only conflict was the Hooks row in qc-helper/SKILL.md: keep this PR's version (with docs/configuration/settings.md added for consistency); main still had the settings-less row. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
qwen-code-ci-bot
left a comment
There was a problem hiding this comment.
No issues found. LGTM! ✅ — qwen3.7-max via Qwen Code /review
qwen-code-ci-bot
left a comment
There was a problem hiding this comment.
No review findings. LGTM! ✅ The single-line change correctly adds docs/configuration/settings.md to the Hooks row in the Common Config Categories table, making it consistent with other rows. All referenced doc paths verified to exist. — Qwen Code via /review
What this PR does
The
qc-helperbundled skill maintains a documentation index (tables mapping topics to doc file paths) that it uses to locate and load the correct user docs when answering configuration questions. This index had several stale and missing entries, causing the skill to either fail to find relevant docs or silently skip them.Three fixes in one file (
packages/core/src/skills/bundled/qc-helper/SKILL.md):docs/configuration/memory.mddid not exist — the file lives atdocs/features/memory.md. Moved it to the Features table at the correct path.hooks.md,auto-mode.md,status-line.md,scheduled-tasks.md,worktree.md. These are all real files underdocs/users/features/that the skill previously had no pointer to.docs/features/hooks.md(a 1300-line comprehensive reference). Also addedauto-mode.mdreference to the Tool Approval row.Why it's needed
Users invoke
/qc-helperto ask questions like "how do I set up a PostToolUse hook?" or "what's the difference between allow and deny permissions?". The skill uses the index to decide which doc toread_file. With hooks missing from the index entirely, the skill had no way to discover the hooks documentation — it would fall back to the genericsettings.mdwhich only has a brief mention. Similarly, memory was pointed at a nonexistent path, so any memory-related question would silently miss the dedicated doc.This is a docs-only change to a bundled skill's SKILL.md. No runtime code, no type changes, no tests affected.
Reviewer Test Plan
How to verify
npm run build— should pass (no TS/code changes)./qc-helper how do I configure a hook to run prettier after file writes?— the skill should readdocs/features/hooks.md(check debug logs or observe the tool calls). Before this PR it would fall back tosettings.mdand give a shallow answer./qc-helper how does memory work?— should finddocs/features/memory.md. Before this PR the path was wrong (docs/configuration/memory.mddoesn't exist).ls docs/users/features/{hooks,auto-mode,status-line,scheduled-tasks,worktree,memory}.md.Evidence (Before & After)
N/A — non-user-visible change (bundled skill prompt text only). The behavior difference is observable via
/qc-helperinvocations as described above.Tested on
Environment (optional)
N/A — Markdown-only change.
Risk & Scope
qc-helperwas scoped here.Linked Issues
N/A
中文说明
这个 PR 做了什么
qc-helper这个 bundled skill 内部维护了一份文档索引(topic 到文档路径的映射表),用于在回答用户配置问题时定位并加载正确的用户文档。这份索引存在多个过期和缺失的条目,导致 skill 要么找不到相关文档,要么静默跳过。在一个文件中修复了三类问题(
packages/core/src/skills/bundled/qc-helper/SKILL.md):docs/configuration/memory.md实际不存在——文件位于docs/features/memory.md。已将其移动到 Features 表的正确路径。hooks.md、auto-mode.md、status-line.md、scheduled-tasks.md、worktree.md。这些都是docs/users/features/下真实存在但 skill 之前没有指向的文件。docs/features/hooks.md(一份 1300 行的完整参考文档)。同时为 Tool Approval 行补充了auto-mode.md引用。为什么需要这个改动
用户通过
/qc-helper提出诸如"如何配置一个在文件写入后运行 prettier 的 hook?"或"allow 和 deny 权限有什么区别?"这类问题。skill 依赖索引来决定read_file读取哪个文档。在 Hooks 完全缺失于索引的情况下,skill 无法发现 hooks 文档——只能退而求其次使用泛化的settings.md,给出浅显的回答。同样,memory 指向了一个不存在的路径,所有关于 memory 的问题都会静默错过专用文档。这是一个仅涉及 bundled skill SKILL.md 的文档变更。没有运行时代码、没有类型变更、不影响测试。
风险与范围
qc-helper。🤖 Generated with Qwen Code