Skip to content

[deep-report] README Overview: mention Claude/Codex/Gemini alongside Copilot — engine signal is zero for non-Copilot users (5-day persistent d [Content truncated due to length] #33079

Description

@github-actions

Context

The Claude Code User Documentation Review has flagged the same finding for five consecutive daily reports (2026-05-14, -15, -16, -17, -18 — most recent: #33042):

The README has no mention of Claude in its Overview, the engine guide recommends Copilot when "unsure", gh aw init creates a Copilot-flavored agent file unconditionally, and several tool docs are silent on which engines support them.

The Quick Start (docs/src/content/docs/setup/quick-start.mdx) was recently improved to list all four engines, so the on-ramp inside the docs site is now engine-agnostic. The README — the first thing a non-Copilot user sees — has not been updated to match.

Why it matters

  • README is the highest-traffic entry point (sits on github.com/github/gh-aw)
  • A Claude / Codex / Gemini user sees only Copilot branding and bounces
  • This is the only persistent documentation drift item that has not improved in 5 daily passes
  • Trend in recent reports: stable — no regressions, no measurable fixes

Proposed change

Update the README Overview section to:

  1. Mention all four supported engines (Copilot, Claude, Codex, Gemini) by name in the opening paragraph
  2. Add a small "Choose your engine" table or callout linking to docs/src/content/docs/configuration/engines.md
  3. Soften or remove the engines.md:28 recommendation that defaults to Copilot — current text "If you are unsure, start with Copilot" is engine-biased
  4. Optionally: ship Quick Start ordering so the Anthropic-key callout is not buried behind the Copilot setup callout

Suggested agent

Documentation Noob Tester or the Claude Code User Documentation Review agent itself — both have re-read this surface repeatedly.

Estimated effort

Small: README edit + one-line tweak to engines.md. Mechanical content update.

Source

Claude Code User Documentation Review #33042 (and 4 prior daily reports).

Generated by 🔬 DeepReport - Intelligence Gathering Agent · ● 19.5M ·

  • expires on May 20, 2026, 4:10 PM UTC

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions