-
Notifications
You must be signed in to change notification settings - Fork 31
Description
Problem / Why
The tutorial doesn’t clearly state prerequisites or why they’re needed, and current setup guidance sends users away mid-flow. This increases drop-off. At the same time, duplicating full install steps across many tutorials risks inconsistency.
What to do
- Inline (keep tutorial runnable)
-
Add a Prerequisites matrix near the top with “why” for:
-
Wallet (approve tx)
-
Testnet coins (fees)
-
Node.js (run scripts/tools)
-
npm (deps)
-
Git (optional)
-
Blueprint (scaffold/test/deploy)
-
Add a short Quick Setup block with copy/paste commands:
-
Install nvm, install/use Node v22+, verify versions
-
Run the Blueprint scaffold command (so user can proceed immediately)
- Canonical setup page (avoid duplication)
-
Create/extend a single page: “Environment setup” (or similar) with the full details:
-
nvm install variants (macOS/Linux), troubleshooting, Windows note
-
Wallet + testnet faucet steps
-
Blueprint overview and optional flags
-
Update the tutorial to link to it as: “Need troubleshooting or Windows steps? See Environment setup.”
Acceptance criteria
- A new reader can complete setup without leaving the tutorial, using the inline quick setup block.
- Full setup instructions exist in one canonical page and are referenced from tutorials.
- Node.js uses nvm as preferred method; Blueprint scaffold command is shown inline.
- No long duplicated setup prose across multiple tutorials; only the quick block is repeated.