[DRAFT] docs(bootstrap): explain what the dispatcher script does (#9421)#9824
Draft
lonexreb wants to merge 1 commit intowarpdotdev:masterfrom
Draft
[DRAFT] docs(bootstrap): explain what the dispatcher script does (#9421)#9824lonexreb wants to merge 1 commit intowarpdotdev:masterfrom
lonexreb wants to merge 1 commit intowarpdotdev:masterfrom
Conversation
…tdev#9421) [DRAFT — minimal slice of warpdotdev#9421] The reporter raised eight distinct concerns about the bootstrap process (README docs, sudo prompts, brew casks, gcloud auth, etc.). This PR addresses **only** the first one — the lack of an up-front explanation of what the dispatcher script does — by adding a comment block at the top of `script/bootstrap` that summarises: - what categories of installation each platform script performs, - what operations require `sudo` / Administrator, - where to find the per-platform logic if you want to install deps through your own toolchain (Volta, asdf, OrbStack, etc.). Intentionally not changing any behavior. The other concerns in warpdotdev#9421 (cargo-bundle git pin, brew casks, Docker assumption, gcloud) are real but each their own design debate; better split out so reviewers can take them one at a time. Honest test status: this is a comment-only change to a Bash dispatcher script. `bash -n script/bootstrap` parses cleanly; no runtime change to exercise. Maintainer should pick the wording they want — happy to adjust.
github-actions
Bot
added
the
external-contributor
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.
#9421 raised eight separate concerns about the bootstrap process. This PR addresses only the first one — the up-front explanation of what the script does — by adding a comment block at the top of `script/bootstrap`. The other seven (cargo-bundle git pin, brew casks, Docker default, gcloud auth, etc.) are real but each their own design debate; happy to follow up on those individually if maintainers want them split that way.
Description
Resolves the documentation portion of #9421.
The dispatcher `script/bootstrap` is what `README.md` tells new contributors to run. Before this PR it was a 14-line conditional with no preamble. After this PR it carries a ~30-line comment block summarising what each platform script will do, what operations require `sudo`, and where to find the actual installation logic if you want to install deps your own way (Volta over corepack, OrbStack over Docker, etc.).
Linked Issue
Partially resolves #9421.
Changes
Honest test status
Agent Mode
CHANGELOG-IMPROVEMENT: `script/bootstrap` now opens with an up-front summary of what each platform script will install and which operations require sudo. Thanks @lonexreb!