-
Notifications
You must be signed in to change notification settings - Fork 3
Add usage examples for each command in README workflow section #57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: workshur <[email protected]>
…mples, update tasks/implement examples Co-authored-by: workshur <[email protected]>
Updated examples for usage of /awos commands to improve clarity and conciseness.
|
@copilot update file following the style from latest commit |
Co-authored-by: workshur <[email protected]>
There was a problem hiding this 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
Task: Add usage examples (Good vs Bad) for each command in README.md ✅
Completed:
/awos:specinto 2 separate features (both good)/awos:spec(too generic)/awos:tasksto show empty list as valid/awos:implementwith better examples (no bad example)Summary:
Successfully updated README.md with compact, consistent examples for all 7 AWOS commands. All examples now use a single bash code block with:
# ✅ Good:/# ❌ Bad:) instead of separate markdown headers>Style improvements:
Original prompt
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.