Skip to content

docs: beginner onboarding + fix newcomer CLI footguns#1

Merged
marinom2 merged 1 commit into
mainfrom
docs/beginner-onboarding
May 31, 2026
Merged

docs: beginner onboarding + fix newcomer CLI footguns#1
marinom2 merged 1 commit into
mainfrom
docs/beginner-onboarding

Conversation

@marinom2
Copy link
Copy Markdown
Owner

@marinom2 marinom2 commented May 31, 2026

What and why

Makes the toolkit approachable for developers new to blockchain/Node.js. All changes are additive; no existing reference content was removed or reworded.

Added

  • GETTING-STARTED.md: a zero-assumptions guide with a short glossary, make a wallet then faucet then first AI call, testnet vs mainnet, the create-lightnode-app vs lightnode add distinction (the most common newcomer confusion), and a troubleshooting table mapping real error messages to fixes.
  • On-ramp links to the guide from README.md, sdk/README.md, and create-lightnode-app/README.md.

Fixed (real newcomer footguns)

  • create-lightnode-app: the cd into the new folder is now flagged as the first critical step, with an explicit note about the npm error Missing script: "dev" you get when running in the wrong directory.
  • lightnode add: output now states files land in the current folder (not a new project), distinguishing it from create-lightnode-app.
  • Missing tsx: the node/script template printed tsx <file>.ts but never installed tsx. Now tsx is added to the install list and the printed run steps use npx tsx, so the command works.

Verification

  • Both packages typecheck and build clean.
  • Rebuilt dist and ran the actual CLIs to confirm the new output prints correctly.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 31, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
lightnode Ready Ready Preview, Comment May 31, 2026 2:11pm

Request Review

Make the SDK approachable for developers new to blockchain/Node.js,
additively (no existing reference content removed).

- add GETTING-STARTED.md: zero-assumptions guide (wallet, faucet, first
  call, testnet vs mainnet, the create-lightnode-app vs `lightnode add`
  distinction, troubleshooting table)
- README/sdk/create-lightnode-app: link to the guide as an on-ramp
- create-lightnode-app: make `cd <folder>` prominent and explain the
  `Missing script: "dev"` error new users hit when running in the wrong dir
- lightnode add: clarify files land in the CURRENT folder, not a new one
- fix: install tsx for the node/script template and use `npx tsx` in
  printed run steps so `tsx <file>.ts` no longer fails with command-not-found
@marinom2 marinom2 force-pushed the docs/beginner-onboarding branch from 925887e to 2ae449e Compare May 31, 2026 14:10
@marinom2 marinom2 merged commit 0f74c5f into main May 31, 2026
2 of 5 checks passed
@marinom2 marinom2 deleted the docs/beginner-onboarding branch May 31, 2026 14:11
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