Skip to content

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

@github-actions

Description

@github-actions

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

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions