Skip to content

docs: align CLI/SDK docs with code, drop internal note#27

Merged
enixCode merged 2 commits into
mainfrom
docs/match-reality
Jun 4, 2026
Merged

docs: align CLI/SDK docs with code, drop internal note#27
enixCode merged 2 commits into
mainfrom
docs/match-reality

Conversation

@enixCode
Copy link
Copy Markdown
Owner

@enixCode enixCode commented Jun 4, 2026

Aligns documentation with the actual code and unifies wording across the ecosystem. Doc-only (no src changes). Derived from a multi-agent audit of docs vs source.

build with cc

Also includes the earlier Execution-page fix (LIGHT_RUN_URL optional in all-in-one).

enixCode added 2 commits June 4, 2026 16:08
- the Configuration block said `LIGHT_RUN_URL ... # required`; it is only
  required for the explicit-runner mode. All-in-one (default) spawns a local
  light-run, nothing to export
- rewrite the Health check section to match what `light doctor` actually does
  in each mode (binary check vs /health ping)

build with cc
- cli.mdx: drop nonexistent serve --verbose; add --runner-port/--install;
  LIGHT_RUN_URL optional (all-in-one); endpoints Auth column; remote --key
  optional; add light node dev; check list matches real output
- getting-started: python node also creates lp.js + input.json
- sdk.mdx: /api/meta is public; null-safe onStatusChange example
- README: remove internal POC note from the public header

build with cc
@enixCode enixCode merged commit e7e8cc4 into main Jun 4, 2026
5 checks passed
@enixCode enixCode deleted the docs/match-reality branch June 4, 2026 15:07
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