Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 31, 2025

Task: Add usage examples (Good vs Bad) for each command in README.md ✅

Completed:

  • Explore repository structure and understand current README.md
  • Identify the commands that need examples (7 commands total)
  • Create Good vs Bad examples for each command using the "Beer and Smile Photo App" scenario
  • Update "Step 2: Follow the Workflow" section in README.md with examples
  • Review changes for clarity and consistency
  • Verify formatting and style with prettier
  • Code review passed with no issues
  • Security check passed (no code changes)
  • Address PR feedback:
    • Use code snippet format for all examples
    • Add reasoning (why users need the Beer & Smile app)
    • Split /awos:spec into 2 separate features (both good)
    • Add second bad example for /awos:spec (too generic)
    • Update /awos:tasks to show empty list as valid
    • Update /awos:implement with better examples (no bad example)
  • Update all examples to follow compact bash comment style

Summary:

Successfully updated README.md with compact, consistent examples for all 7 AWOS commands. All examples now use a single bash code block with:

  • Comments (# ✅ Good: / # ❌ Bad:) instead of separate markdown headers
  • Command and description on the same line after >
  • Explanatory comments instead of italicized text below code blocks
  • More concise, readable format throughout

Style improvements:

  • All 7 commands now use consistent compact format
  • Examples are more scannable and easier to read
  • Reduced visual clutter while maintaining clarity
Original prompt

This section details on the original issue you should resolve

<issue_title>Include usage examples for each command in the README to help users understand their functionality more easily.</issue_title>
<issue_description>Apply the method of demonstrating concepts with both good and bad examples.</issue_description>

<agent_instructions>We need to update "Step 2: Follow the Workflow" in README.md

For the each command we need to create small Good vs Bad examples. Our product for '/awos:product' will be an agentic tool which allows user to upload photo with person, and it will add Beer and smile to this photo& Do not overcomplicate& It is just a documentation example</agent_instructions>

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

Note

Custom agent used: DocWriter
Writes short, precise repository docs. Uses lists, parameter tables, relative code links, and minimal runnable snippets.


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

Copilot AI changed the title [WIP] Add usage examples for each command in README Add usage examples for each command in README workflow section Oct 31, 2025
Copilot AI requested a review from workshur October 31, 2025 15:29
Copilot finished work on behalf of workshur October 31, 2025 15:29
…mples, update tasks/implement examples

Co-authored-by: workshur <[email protected]>
Copilot AI requested a review from workshur October 31, 2025 15:50
Copilot finished work on behalf of workshur October 31, 2025 15:50
Updated examples for usage of /awos commands to improve clarity and conciseness.
@workshur
Copy link
Member

@copilot update file following the style from latest commit

Copy link
Contributor Author

Copilot AI commented Oct 31, 2025

@copilot update file following the style from latest commit

Updated all command examples to follow the compact bash comment style in commit 5430dc7. All examples now use a single code block with # ✅ Good: / # ❌ Bad: comments and inline descriptions.

Copilot finished work on behalf of workshur October 31, 2025 17:56
@workshur workshur requested a review from mkf-simpson October 31, 2025 18:09
@workshur workshur marked this pull request as ready for review October 31, 2025 18:09
Copilot AI review requested due to automatic review settings October 31, 2025 18:09
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the README documentation by adding concrete usage examples for each of the seven AWOS workflow commands. The changes help users understand the correct way to invoke each command by providing both good and bad examples with explanatory comments.

Key Changes

  • Added "Example Usage" sections for all seven AWOS commands (/awos:product, /awos:roadmap, /awos:architecture, /awos:spec, /awos:tech, /awos:tasks, /awos:implement)
  • Each example section includes both ✅ Good and ❌ Bad usage patterns with explanations of why certain approaches are inappropriate
  • Examples use a consistent "photo editing app" scenario across all commands to demonstrate the full workflow

@mkf-simpson mkf-simpson merged commit f5624cf into main Nov 4, 2025
10 checks passed
@mkf-simpson mkf-simpson deleted the copilot/update-readme-usage-examples branch November 4, 2025 13:34
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.

Include usage examples for each command in the README to help users understand their functionality more easily.

3 participants