Skip to content

Add daily workflow to audit documentation for Claude Code users#11351

Merged
pelikhan merged 3 commits intomainfrom
copilot/review-readme-for-claude-code-users
Jan 22, 2026
Merged

Add daily workflow to audit documentation for Claude Code users#11351
pelikhan merged 3 commits intomainfrom
copilot/review-readme-for-claude-code-users

Conversation

Copy link
Contributor

Copilot AI commented Jan 22, 2026

Documentation may contain Copilot-centric assumptions that block adoption for users who rely on Claude Code and standard GitHub features. This adds automated detection and tracking of such barriers.

Changes

  • Workflow: .github/workflows/claude-code-user-docs-review.md

    • Runs daily using Claude engine (matches target user persona)
    • Reviews README, Quick Start, Architecture, Tools, CLI docs
    • Analyzes through three lenses:
      1. Onboarding experience clarity for non-Copilot users
      2. Feature accessibility without Copilot/Copilot CLI
      3. Documentation assumptions about Copilot availability
    • Bash tool access: Configured with unrestricted bash command access (bash: ["*"]) to enable flexible documentation exploration
  • Output: GitHub Discussion with structured findings

    • Severity-categorized blockers (Critical/Major/Minor)
    • Engine comparison matrix (Copilot/Claude/Codex documentation parity)
    • Authentication requirements breakdown by engine
    • Actionable recommendations with file references
    • Adoption viability score

Example workflow configuration

engine: claude
tools:
  cache-memory: true
  github:
    toolsets: [default, discussions]
  bash:
    - "*"  # Allows all bash commands for comprehensive analysis
safe-outputs:
  create-discussion:
    category: "General"
    close-older-discussions: true

Enables continuous monitoring of documentation accessibility for the Claude Code user segment.

Custom agent used: agentic-workflows
GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing

Original prompt

Create a daily agentic-workflow that reviews the project README or documentation from the perspective of a Claude Code user who:

  • Uses GitHub
  • Uses Claude Code
  • Does not use GitHub Copilot or the Copilot CLI

The workflow should answer:

  1. What is the experience of this user when trying to learn about and adopt GitHub agentic-workflows?
  2. Are there any features or steps in the documentation that do not work, or are inaccessible, for users who are not using the Copilot CLI?
  3. Does the documentation reveal any blockers to adoption for users who:
    • Do not use @copilot
    • Do not use the copilot-cli
    • Rely primarily on Claude Code plus standard GitHub features?

The goal is to identify and track any blockers, missing explanations, or assumptions in the documentation that would prevent a Claude Code–only GitHub user from successfully understanding and adopting gh-aw.
Create a discussion with the result.

Custom agent used: agentic-workflows
GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Create workflow for reviewing GitHub documentation for Claude Code users Add daily workflow to audit documentation for Claude Code users Jan 22, 2026
Copilot AI requested a review from pelikhan January 22, 2026 16:38
@pelikhan
Copy link
Contributor

@copilot allow bash *

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 22, 2026

@copilot allow bash *

Done in 87cce5d. Changed bash configuration from allowlist to bash: ["*"] to allow all bash commands.

@pelikhan pelikhan marked this pull request as ready for review January 22, 2026 16:47
@pelikhan pelikhan merged commit e659513 into main Jan 22, 2026
@pelikhan pelikhan deleted the copilot/review-readme-for-claude-code-users branch January 22, 2026 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants