Skip to content

Add concrete usage examples for all major tools - #31

Closed
TerminalGravity wants to merge 2 commits into
mainfrom
add-usage-examples
Closed

Add concrete usage examples for all major tools#31
TerminalGravity wants to merge 2 commits into
mainfrom
add-usage-examples

Conversation

@TerminalGravity

Copy link
Copy Markdown
Collaborator

Created examples/USAGE_EXAMPLES.md with 8 real-world scenarios showing what each tool looks like in practice. Added link in README nav bar.

… and contracts

The README references .preflight/ config extensively but there were no
concrete example files to copy. This adds a ready-to-use examples/.preflight/
directory with annotated config.yml, triage.yml, and contracts/api.yml,
plus a README explaining how to use them.
Created examples/USAGE_EXAMPLES.md with 8 real-world scenarios showing
what each tool looks like in practice: preflight_check catching vague
prompts, scope_work creating execution plans, enrich_agent_task for
sub-agents, sharpen_followup resolving ambiguity, session health checks,
semantic history search, weekly scorecards, and prompt grading.

Added link to usage examples in README nav bar.

@TerminalGravity TerminalGravity left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Usage examples doc is thorough — covering the real workflow from vague prompt through triage to refined output is exactly what people need to grok the value prop.

Same note as the other PRs: includes README nav changes and example configs that overlap with #34, #32, etc. Land order matters here.

Content-wise, LGTM.

@TerminalGravity

Copy link
Copy Markdown
Collaborator Author

Superseded by newer PRs.

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.

1 participant