docs: add usage walkthrough with realistic tool output examples - #253
Open
TerminalGravity wants to merge 1 commit into
Open
docs: add usage walkthrough with realistic tool output examples#253TerminalGravity wants to merge 1 commit into
TerminalGravity wants to merge 1 commit into
Conversation
Shows 4 concrete scenarios: vague prompt clarification, multi-step scoping, correction pattern matching, and cross-service awareness. Each example includes the prompt, triage classification, and the actual output users can expect.
TerminalGravity
commented
Mar 16, 2026
TerminalGravity
left a comment
TerminalGravity
left a comment
Collaborator
Author
There was a problem hiding this comment.
The walkthrough examples showing actual tool output are really well done — way more tangible than abstract descriptions. This will help a lot with adoption. Ready to merge.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new 'Usage Walkthrough' section to the README showing 4 concrete scenarios with realistic preflight output:
Helps new users understand what preflight actually does before installing it.