[information-architecture] Copilot availability prerequisite is hidden from primary install entry points

Aperta Adatta ai principianti
#2,511 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github-actions
Ambito
documentation

Direzione di ricerca

Inizia leggendo la sezione Quick setup di README.md (circa righe 28-40) e la sezione Install di docs/workflows/gh-agent-workflows.md (circa righe 5-27). Copia poi la formulazione del requisito Copilot dalla riga 11 di docs/index.md. Aggiungi un riquadro di prerequisito di una sola riga vicino ai primi comandi di installazione in entrambi i file, usando la stessa formulazione. È completato quando chi legge una delle due pagine vede il requisito Copilot prima dei passaggi di installazione e i tre file sono coerenti.

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

Descrizione

information-architecture

Information Architecture Findings

1. Copilot prerequisite is only surfaced on one onboarding path

Area: Empty states and onboarding
Component(s): README.md, docs/workflows/gh-agent-workflows.md, docs/index.md
Problem: The two most likely setup entry points (README.md quick setup and docs/workflows/gh-agent-workflows.md install section) present install actions immediately but do not state the prerequisite that the repo/org must have GitHub Copilot available. That prerequisite appears in docs/index.md only. Users who start from README or workflow overview can follow installation steps successfully, then hit failing workflows later with no early guidance about why.

Evidence:

  • README.md:28-40 — Quick setup script prerequisites list gh, git, and curl, but no Copilot availability requirement.
  • docs/workflows/gh-agent-workflows.md:5-27 — Install and recommended sets section has no Copilot prerequisite callout.
  • docs/index.md:11 — The Copilot requirement is documented here only.

Suggested improvement: Add a short prerequisite callout (for example, “Requires GitHub Copilot enabled for the repository or organization”) directly in the README quick setup section and the workflow overview install section, near the first install commands.

Suggested Actions

  • Add a Copilot-availability prerequisite line to README.md Quick setup script section (README.md:28-40).
  • Add the same prerequisite callout to docs/workflows/gh-agent-workflows.md Install section (docs/workflows/gh-agent-workflows.md:5-20).
  • Keep wording consistent with docs/index.md:11 to avoid conflicting onboarding guidance.

What is this? | From workflow: Trigger Information Architecture

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Lingua principale
Python
Stelle
13
Fork
16
Merge medio
45m
PR unite (30g)
1

Preparare l'ambiente

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 elastic/ai-github-actions

Tutte le issue di elastic/ai-github-actions

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.