docs: improve quickstart with zero-install npx as primary option#44
Closed
TerminalGravity wants to merge 4 commits intomainfrom
Closed
docs: improve quickstart with zero-install npx as primary option#44TerminalGravity wants to merge 4 commits intomainfrom
TerminalGravity wants to merge 4 commits intomainfrom
Conversation
… 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.
- Reorder options: npx (zero install) → npm global → clone - Add -y flag to npx for non-interactive use - Explain what CLAUDE_PROJECT_DIR enables - Note that .mcp.json paths must be absolute - Use 'absolute' in path placeholders to prevent confusion
Collaborator
Author
|
Superseded by newer PRs. |
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.
What: Restructures the Quick Start section to lead with the zero-install
npx -y preflight-devpath instead of requiring users to clone first.Changes:
-yflag to npx for non-interactive useCLAUDE_PROJECT_DIRenables (contracts, file search, triage).mcp.jsonpaths must be absolute/absolute/path/...in placeholders to prevent confusionWhy: The old Option A ('fastest') still required knowing a clone path. The actual fastest onboarding is a single npx command with no clone step.