Skip to content

[Code Quality] Make documentation engine-neutral to reduce friction for Claude/Codex users #12792

@github-actions

Description

@github-actions

Description

The documentation currently presents a Copilot-first experience that creates unnecessary friction for Claude and Codex users. While the technical implementation is excellent and all engines have feature parity, the documentation's Copilot-centric language makes it harder than necessary for non-Copilot users to get started.

Identified by

Claude Code User Documentation Review #12749

Current Issues

  1. Copilot Listed First: "AI agent (Copilot, Claude, Codex, ...)" signals Copilot as default
  2. Copilot Called "(default)": Explicitly labels Copilot as default when there's no technical reason
  3. Prerequisites Order: Lists "Copilot subscription" before "API keys" suggesting different tiers
  4. Examples Use Copilot: Documentation uses Copilot as singular example instead of showing multiple engines

Files to Update

Core Documentation:

  • README.md - Use engine-neutral language, reorder engine mentions
  • docs/src/content/docs/setup/quick-start.md - Remove Copilot-first positioning
  • docs/src/content/docs/introduction/overview.mdx - Use "AI coding agents" instead of "Copilot"
  • docs/src/content/docs/introduction/how-they-work.mdx - Remove "(default)" designation
  • docs/src/content/docs/setup/agentic-authoring.mdx - Add disclaimer that it's Copilot-specific

Suggested Changes

Language Changes:

  • Before: "AI agent (Copilot, Claude, Codex, ...)"
  • After: "AI coding agents (Anthropic Claude, GitHub Copilot, OpenAI Codex)"

Remove Default Designation:

  • Before: "Workflows support GitHub Copilot (default), Claude Code, and Codex"
  • After: "Workflows support Anthropic Claude, GitHub Copilot, and OpenAI Codex"

Prerequisites Reframe:

  • Use neutral language: "Select your preferred AI engine - all engines provide the same core functionality"

Success Criteria

  • Engine mentions are alphabetical or explicitly equal (no "first" positioning)
  • "(default)" designation removed from engines.md
  • README and Quick Start use engine-neutral language
  • Conceptual docs use "AI coding agents" instead of "Copilot" alone
  • Agentic authoring guide has Copilot-specific disclaimer
  • 29 existing Claude workflow examples are surfaced in documentation

Impact

Current State: Documentation creates friction for ~48% of users (21.5% Claude + 5.6% Codex + 20% unspecified)
After Fix: All users have equal onboarding experience regardless of engine choice

Priority

High - Affects user adoption and reduces documentation clarity score from 10/10 to 7/10

References

AI generated by Discussion Task Miner - Code Quality Improvement Agent

  • expires on Feb 13, 2026, 5:15 PM UTC

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