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

Abierto Apto para principiantes
#2,511 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
github-actions

Línea de trabajo

Empieza leyendo la sección Quick setup de README.md (alrededor de las líneas 28-40) y la sección Install de docs/workflows/gh-agent-workflows.md (alrededor de las líneas 5-27). Después, copia la redacción del requisito de Copilot de docs/index.md, línea 11. Añade una nota de requisito previo de una sola línea cerca de los primeros comandos de instalación en ambos archivos, usando la misma redacción. Está terminado cuando quien lea cualquiera de las dos páginas vea el requisito de Copilot antes de los pasos de instalación y los tres archivos coincidan.

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

Descripción

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.

Lenguaje dominante
Python
Estrellas
13
Forks
16
Merge medio
45 min
PR fusionados (30 d)
1

Preparar el entorno

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

Todos los issues de elastic/ai-github-actions

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.