Skip to content

Optimize install.md for Copilot agent-driven repository setup#11927

Merged
pelikhan merged 5 commits intomainfrom
copilot/optimize-install-md-for-copilot
Jan 26, 2026
Merged

Optimize install.md for Copilot agent-driven repository setup#11927
pelikhan merged 5 commits intomainfrom
copilot/optimize-install-md-for-copilot

Conversation

Copy link
Contributor

Copilot AI commented Jan 26, 2026

Rewrite install.md for GitHub Copilot Agent Scenario ✅

Goal: Optimize install.md for the scenario where a GitHub Copilot agent helps a user configure their repository to use Agentic Workflows by running gh aw init.

All Tasks Completed ✅

  • Analyze current install.md structure and content
  • Understand the target scenario (Copilot agent + user interaction)
  • Design new structure optimized for:
    • Agent-driven setup flow
    • Single key command: gh aw init
    • Minimal manual steps
    • Clear expectations
  • Rewrite install.md with new structure:
    • Brief introduction to what gh-aw is
    • Main action: run gh aw init (interactive mode by default)
    • What gh aw init does in detail
    • Alternative non-interactive mode with flags
    • Post-init next steps
    • Troubleshooting section
    • Agent guidelines for helping users
    • Additional resources and security best practices
  • Review and test the new content
  • Run code review (passed with no comments)
  • Revert all .yml file changes (per feedback)

Key Changes Summary

Structure:

  • Changed from "Interactive Setup Wizard" to "Setup Guide for GitHub Copilot Agents"
  • Streamlined from verbose step-by-step to focused quick setup
  • Emphasized gh aw init as the primary command
  • Added "Agent Guidelines" section with best practices

Content:

  • Removed verbose conversational instructions (agents can be conversational naturally)
  • Highlighted interactive mode as default (no flags needed)
  • Explained what gh aw init does comprehensively
  • Simplified secret configuration steps
  • Added troubleshooting for common issues
  • Included agent-specific guidance at the end

Metrics:

  • Reduced from 334 lines to 262 lines (21% reduction)
  • 133 insertions, 204 deletions in install.md
  • Maintained all essential information while improving clarity

Reverted changes:

  • Reverted all 140 .yml workflow files to their original state
  • Reverted pkg/workflow/data/action_pins.json
  • Only install.md changes remain in this PR

Testing Results

✅ File structure and content reviewed
✅ All sections present and logically organized
✅ Valid markdown format confirmed
✅ Code review passed with no comments
✅ File successfully committed and pushed
✅ All .yml file changes reverted as requested

Original prompt

Rewrite the install.md file (https://github.com/githubnext/gh-aw/blob/main/install.md) to optimize for the github copilot agent scenario where the user starts an agentic task which should configure the repository to use AW. It should run "gh aw init".


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 26, 2026 19:28
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Rewrite install.md for GitHub Copilot agent scenario Optimize install.md for Copilot agent-driven repository setup Jan 26, 2026
Copilot AI requested a review from pelikhan January 26, 2026 19:34
@pelikhan
Copy link
Contributor

@copilot revert .yml file changes

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

Copilot AI commented Jan 26, 2026

@copilot revert .yml file changes

Reverted all .yml file changes in commit d29fa33. The PR now only contains changes to install.md.

@pelikhan pelikhan marked this pull request as ready for review January 26, 2026 20:00
@pelikhan pelikhan merged commit 2a17109 into main Jan 26, 2026
@pelikhan pelikhan deleted the copilot/optimize-install-md-for-copilot branch January 26, 2026 20:00
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