Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Cerrado Apto para principiantes
  • ¿Algo no está bien?
#63,580 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
90/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Área
cli, documentation

Línea de trabajo

Abre docs/src/content/docs/setup/cli.md y compara las secciones Installation, Global Options, --push, Commands, add-wizard, add y new con la guía Quick Start. Mueve las secciones avanzadas después de los recorridos por los comandos principales y añade la referencia cruzada para principiantes solicitada; se considera terminado cuando la página renderizada presenta primero los comandos principales y señala claramente add-wizard a los recién llegados.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Go
Estrellas
5.4k
Forks
596
Merge medio
3 h 24 min
PR fusionados (30 d)
824

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/gh-aw

Todos los issues de github/gh-aw

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.