Add --quick flag for lightweight workflow generation

[Copilot]

The gh aw new command now generates comprehensive documentation (~140 lines) by default, which can overwhelm users creating simple workflows. This adds a --quick flag to generate minimal documentation instead.

Changes

CLI Command

• Added --quick/-q flag to new command with clear mode differentiation in help text
• Quick mode: workflow + 21-line README (setup, triggers, doc link)
• Comprehensive mode: workflow + 142-line README (examples, troubleshooting, best practices)

Implementation

• Extended NewWorkflow() with quick parameter
• Added createQuickReadme() and createComprehensiveReadme() generators
• Both modes always create workflow.md + appropriate README.md

Documentation & Testing

• Updated agent instructions with "Documentation Modes" section
• Added TestNewWorkflowQuickMode covering both modes
• Updated AGENTS.md quick reference

Usage

# Quick mode - minimal docs for simple workflows
gh aw new my-workflow --quick

# Comprehensive mode - detailed docs (default)
gh aw new my-workflow

Quick mode README structure:

• Quick Start (3 steps)
• What This Workflow Does
• Triggering the Workflow
• Documentation link

Comprehensive mode adds: Overview, Features, Setup (Prerequisites + Installation), Configuration (with YAML examples), Usage, Examples, Troubleshooting, Best Practices, Contributing.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>[plan] Add lightweight "Quick Mode" option for workflow generation</issue_title>
<issue_description>## Objective

Implement a lightweight documentation mode that generates minimal output (workflow + basic README) for users who prefer simpler documentation packages.

Context

Research from #12193 shows the agentic-workflows agent consistently creates comprehensive 5-7 file documentation packages (~60-70 KB). While this is excellent for complex use cases, it may overwhelm users with simple requirements. Average quality score was 4.97/5.0 across 6 scenarios, but documentation volume was identified as potential over-engineering for basic workflows.

Approach

1. Add a --quick or --minimal flag to the workflow generation command
2. In quick mode, generate only:
   • The workflow markdown file
   • A single condensed README with essential setup steps
   • Skip INDEX, QUICKREF, EXAMPLE, and template files
3. Preserve the same quality standards but with reduced verbosity
4. Default to comprehensive mode to maintain backward compatibility

Files to Modify

• pkg/cli/*_command.go - Add flag for quick mode
• pkg/workflow/compiler.go - Handle quick mode logic
• Agent instructions in .github/instructions/*.instructions.md - Document quick mode option
• AGENTS.md - Update documentation generation guidelines

Acceptance Criteria

• --quick flag available in workflow generation commands
• Quick mode generates workflow + condensed README only
• Comprehensive mode remains default behavior
• Documentation explains when to use each mode
• Tests validate both modes produce valid workflows

Reference

See discussion #12193 "Recommendations" section: "Add 'Quick Mode' Option"

AI generated by Plan Command for discussion #12193

Comments on the Issue (you are @copilot in this section)

• Fixes [plan] Add lightweight "Quick Mode" option for workflow generation #12202

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[pelikhan]

@copilot always use the quick template , remove complex readme

[Copilot]

@pelikhan Unfortunately I hit an unexpected error while processing your comment. I've automatically reported this to GitHub.

You can ask me to try again later by mentioning me in a new comment.

If you want to contact GitHub about this error, please mention the following identifier so they can better serve you: 72bfc3b5-88b1-4634-b241-be7dbe53304c

Sorry for the inconvenience!