docs: clarify newbie onboarding path#24
Merged
Merged
Conversation
- fix the `light doctor` reference: it checked Docker/gVisor/GPU/Node>=18 that doctor.ts never runs; document the real Node + LIGHT_RUN_URL + binary/health checks - add a one-breath mental model (node/link/workflow) at the top of getting-started so the commands have context - explain the scaffolded `main.js` (SDK equivalent of `light run example`) and point at the SDK guide - flag networkDefs/services as advanced so first-time readers can skip them build with cc
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.
Why
A newbie starting on the stack hits four friction points in the docs. This is doc-only, light-process only.
Changes
light doctorreference (factual bug).cli.mdxdescribed checks (Docker install, daemon, gVisor, GPU plugin, Node >= 18) thatsrc/cli/doctor.tsnever runs. Replaced with the real behaviour: Node version,LIGHT_RUN_URL, and the all-in-one (binary present) vs explicit (/healthreachable) modes. Now consistent with the real output already shown ingetting-started.getting-startedso the commands have context before the reader reachesWorkflows.main.js.light initscaffolds amain.js(SDK equivalent oflight run example) that was never explained. Added a short "Run from code" section with the real snippet + pointer to the SDK guide.networkDefs/services as advanced so first-time readers can skip them.Verification
<Callout>).build with cc