[deep-report] Reorder CLI docs page: move advanced flags after core commands, cross-link add-wizard/add/new
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 90/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 领域
- cli, documentation
调研方向
打开 docs/src/content/docs/setup/cli.md，并将其中的 Installation、Global Options、--push、Commands、add-wizard、add 和 new 部分与 Quick Start 指南进行比较。将高级部分移到核心命令演练之后，并添加所要求的面向初学者的交叉引用；完成标准是渲染后的页面先呈现核心命令，并明确将新用户指向 add-wizard。
由索引模型根据 Issue 内容生成。
描述
Description
docs/src/content/docs/setup/cli.md introduces "Global Options" (line 80) and "The --push Flag" (line 93) immediately after "Installation" (line 29) and before the core command walkthroughs ("Commands" section starts at line 99, add-wizard detail at line 146). A first-time reader following the Quick Start guide hits advanced flag documentation (--push, global options) before ever seeing what add, add-wizard, or new actually do. Separately, add-wizard (line 146), add, and new are documented with equal weight in this reference page, while the Quick Start guide only ever uses add-wizard — there's no cross-link telling a reader bouncing between the two pages which command is "the real starting point."
Fix
- Move "Global Options" / "The
--pushFlag" to after the core command walkthrough sections (or add a "skip to core commands" anchor right after Installation). - Add a short cross-reference from the
add/newsections back to "if you're just getting started, see Quick Start'sadd-wizardwalkthrough."
Expected Impact
Reduces first-time-user friction identified via live doc walkthrough — new users no longer wade through advanced flags before core commands, and the three similarly-named onboarding commands (add-wizard/add/new) get an explicit beginner-facing recommendation.
Suggested Agent
docs-noob-tester workflow's own follow-up, or any general-purpose docs-editing agent.
Estimated Effort
Medium (1-4 hours)
Data Source
DeepReport Intelligence Briefing (2026-09-26 incremental cycle), sourced from Documentation Noob Test Report #63549 ("Confusing Areas" #3 and #4), live-verified against docs/src/content/docs/setup/cli.md section ordering.
Generated by 🔬 Deep Report · claude · agent · 160.7 AIC · ⌖ 9.58 AIC · ⊞ 12.9K · ◷
- expires on Sep 27, 2026, 10:45 PM UTC-08:00
- 主要语言
- Go
- 星标
- 5.4k
- 派生
- 596
- 平均合并
- 3 小时 24 分钟
- 30 天内合并 PR
- 824
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/gh-aw 的其他 Issue
-
automation models
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
agent-research
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
agentic-workflows automation aw-essential cookie
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
automated conformance safe-outputs
难度 1/5 1 小时以内 新手友好度 75/100
维护者通常 1 天内回复
-
automated conformance safe-outputs
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
相似的 Issue
-
bug triage
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
mvanhorn/cli-printing-press#5146 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 74/100
AvengeMedia/DankMaterialShell#3853 ·
-
难度 2/5 1-3 小时 新手友好度 60/100
-
难度 1/5 1 小时以内 新手友好度 85/100
维护者通常 1 天内回复