Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Chiusa Adatta ai principianti
  • Qualcosa non va?
#63,580 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
90/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
cli, documentation

Direzione di ricerca

Apri docs/src/content/docs/setup/cli.md e confronta le sezioni Installation, Global Options, --push, Commands, add-wizard, add e new con la guida Quick Start. Sposta le sezioni avanzate dopo le spiegazioni dei comandi principali e aggiungi il riferimento incrociato per principianti richiesto; il lavoro è completato quando la pagina renderizzata presenta prima i comandi principali e indica chiaramente add-wizard ai nuovi utenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
Go
Stelle
5.4k
Fork
596
Merge medio
3h 41m
PR unite (30g)
829

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/gh-aw

Tutte le issue di github/gh-aw

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.