docs(getting-started): fix the zero-to-first-workflow path#23
Merged
Conversation
The getting-started page had several inaccuracies that would block a new user: - Node.js requirement said >= 18; the package requires >= 20. - Only installed light-process, never the execution server. Install both and explain all-in-one (auto-spawn) vs explicit-runner mode. - The `light doctor` sample output was fictional (showed Docker checks the command never runs). Replaced with the real output from src/cli/doctor.ts for both the all-in-one and explicit-runner paths. - Claimed a web dashboard at localhost:3000; the UI (ui/out) is not built by default. Added the caveat + build steps. - Showed how to add a second node but never how to wire it. Added a `light link` step with --from/--to and a --when condition example. 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.
Fix getting-started inaccuracies blocking a zero-to-first-workflow run: Node >=18 -> >=20; install both packages and explain all-in-one (auto-spawn) vs explicit runner; replace the fictional light doctor output with the real output from src/cli/doctor.ts (both modes); drop the unconditional dashboard claim (ui/out is not built by default) and add the build steps; add the missing light link --from/--to[--when] step. Docs-only, each claim verified against doctor.ts / serve.ts / link.ts. build with cc