docs: clarify vital vs optional binaries in install section#254
Closed
Alexgodoroja wants to merge 1 commit into
Closed
docs: clarify vital vs optional binaries in install section#254Alexgodoroja wants to merge 1 commit into
Alexgodoroja wants to merge 1 commit into
Conversation
Name the three vital binaries the core depends on — pilot-daemon (the node), pilotctl (the CLI), and pilot-updater (the background auto-updater, present when automatic updates are enabled) — and mark pilot-gateway as optional (extras-only; release tarballs ship daemon/pilotctl/updater only; the core runs without it). Correct the installer bullet that implied pilot-gateway always ships, and note the SDKs are libraries over the libpilot C FFI, not a standalone binary. Verified against install.sh and cmd/.
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.
What
Briefly documents which binaries are essential to Pilot Protocol versus optional, in the README Install section. Every name is verified against
install.shandcmd/.Changes (
README.md)pilot-daemon(the node),pilotctl(the CLI), andpilot-updater(the background auto-updater, installed when automatic updates are enabled).pilot-gateway— powers the TCP/HTTP gateway extras, ships only when built (release tarballs carry daemon/pilotctl/updater only), and the core runs fine without it.pilot-gatewayas if it always ships, contradictinginstall.sh.libpilotC FFI — there is nopilot-sdkbinary.Docs only, no behavior change.