Skip to content

[plan] Update README.md engine ordering to show engines as equals #12033

@github-actions

Description

@github-actions

Context

As identified in discussion #12027, the README.md lists "Copilot" first when describing engine options, which creates an implicit bias suggesting Copilot is the primary or default engine.

Current State

README.md:78 states:

"The gh aw cli converts this into a GitHub Actions Workflow (.yml) that runs an AI agent (Copilot, Claude, Codex, ...) in a containerized environment"

Problem

  • Bold formatting on "Copilot" emphasizes it over other engines
  • Listing Copilot first suggests it's the primary/preferred option
  • Creates expectation that other engines are secondary alternatives
  • Contradicts the project's multi-engine design philosophy

Objective

Update the README to present all engines as equal options without implicit bias.

Proposed Solution

Change README.md:78 from:

runs an AI agent (**Copilot**, Claude, Codex, ...) in a containerized environment

To:

runs an AI agent (**Claude, Copilot, Codex, or custom**) in a containerized environment

Files to Modify

  • README.md (around line 78)

Acceptance Criteria

  • Update engine listing to show engines as equals
  • Remove or balance bold formatting
  • List engines alphabetically or as "Claude, Copilot, Codex"
  • Add "or custom" to acknowledge custom engine support
  • Verify README renders correctly on GitHub

Alternative Approaches

  • Could list alphabetically: "Claude, Codex, Copilot, or custom"
  • Could remove bold formatting entirely: "runs an AI agent (Claude, Copilot, Codex, or custom)"
  • Could emphasize all: "runs an AI agent (Claude, Copilot, Codex, or custom)"

References

AI generated by Plan Command for discussion #12027

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions