Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[deep-report] Reorder CLI docs page: move advanced flags after core commands, cross-link add-wizard/add/new

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#63,580 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
90/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Mở docs/src/content/docs/setup/cli.md và so sánh các phần Installation, Global Options, --push, Commands, add-wizard, add và new với hướng dẫn Quick Start. Di chuyển các phần nâng cao xuống sau phần hướng dẫn các lệnh cốt lõi và thêm tham chiếu chéo dành cho người mới bắt đầu theo yêu cầu; hoàn tất khi trang được kết xuất hiển thị các lệnh cốt lõi trước và chỉ dẫn rõ ràng người dùng mới đến add-wizard.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

automation code-quality cookie improvement quick-win task-mining
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
  1. Move "Global Options" / "The --push Flag" to after the core command walkthrough sections (or add a "skip to core commands" anchor right after Installation).
  2. Add a short cross-reference from the add/new sections back to "if you're just getting started, see Quick Start's add-wizard walkthrough."
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
Ngôn ngữ chính
Go
Star
5.4k
Fork
596
Merge trung bình
3 giờ 41 phút
Pull request đã merge (30 ngày)
829

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/gh-aw

Tất cả issue của github/gh-aw

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.