Skip to content

[plan] Annotate gh aw init agent-file scaffolding as Copilot-specific in docs #31208

@github-actions

Description

@github-actions

Context

Created from the Claude Code User Documentation Review in discussion #31206.

Objective

Document that the .github/agents/agentic-workflows.agent.md file created by gh aw init is only used by the Copilot engine, so Claude/Codex/Gemini users aren't confused by a Copilot-only artifact in their repo.

Current State

docs/src/content/docs/setup/cli.md line ~134 says:

"Configures .gitattributes, creates the dispatcher agent file (.github/agents/agentic-workflows.agent.md)"

There is no note that this agent file is Copilot-specific. A Claude user running gh aw init gets a Copilot-only artifact committed to their repo with no guidance on what to do with it.

Approach

  1. Open docs/src/content/docs/setup/cli.md around line 134
  2. Add a note/callout after the gh aw init description: "The dispatcher agent file (.github/agents/agentic-workflows.agent.md) is only used by the Copilot engine. If you plan to use Claude, Codex, or Gemini exclusively, you can safely delete this file — it has no effect on other engines."
  3. Consider also adding --engine <engine> flag documentation to gh aw init if that flag exists (check actual CLI behavior first)

Files to Modify

  • docs/src/content/docs/setup/cli.md

Acceptance Criteria

  • The gh aw init section clearly states the agent file is Copilot-specific
  • Non-Copilot users have explicit guidance ("you can delete this file")
  • If gh aw init --engine flag exists, it is documented

Generated by Plan Command for issue #discussion #31206 · ● 4.4M ·

  • expires on May 11, 2026, 1:00 PM UTC

Metadata

Metadata

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions