docs: bring site copy in line with the v1.0.0 CLI - #35
Open
fullstackjam wants to merge 1 commit into
Open
Conversation
- Landing page mock terminal showed a hardcoded 'Downloading OpenBoot v0.44.0' direct-download flow; install.sh now installs through Homebrew, so mirror its actual output and drop the version string. - cli-reference: 'openboot update' still exists in v1.0 (brew upgrade wrapper on Homebrew installs, pin/rollback on direct installs); it was wrongly listed as removed. Fix the --update flag meaning (update Homebrew and exit) and the doctor table (state file and PATH checks). - faq: drop the claim that 'update --self' was removed. - env-vars: OPENBOOT_VERSION is a dead variable in install.sh; add OPENBOOT_DOTFILES, OPENBOOT_DISABLE_AUTOUPDATE, OPENBOOT_API_URL which the CLI reads but the page omitted. - quick-start / what-is-openboot: bare 'openboot' prints help; the wizard is 'openboot install'. Presets never become a sync source.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
5 tasks
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 was stale
The site was last touched on Jul 18, before v1.0.0 (Aug 2). Audited every page under
src/docs/and the landing page against the v1.0.0 binary (openboot <cmd> --help),scripts/install.sh, and the Go source.Downloading OpenBoot v0.44.0...direct-download flow.install.shinstalls through Homebrew now; the mock mirrors its real output and no longer carries a version string.openboot updatewas listed as removed in v1.0. It exists (brew upgradewrapper on Homebrew installs;--version/--rollback/--list-backupson direct installs, perinternal/cli/update.go). Added it to the command list and replaced the "no self-update command" section. Also fixed--update(it updates Homebrew and exits, it does not install) and two doctor rows: the state check looks atsync_source.json/state.json, notinstall_state.json; the PATH check is/opt/homebrew/binon Apple Silicon only.openboot update --selfwas removed.OPENBOOT_VERSIONis assigned on line 4 ofinstall.shand never read; removed the row. AddedOPENBOOT_DOTFILES,OPENBOOT_DISABLE_AUTOUPDATE,OPENBOOT_API_URL, which the CLI reads but the page (which claims to be exhaustive) omitted.openbootprints help (root command has noRun); the wizard isopenboot install. Presets never become a sync source (SyncSourceis user/slug only), so "(or a preset)" is gone.Verification
npm run validate: eslint 0 errors (223 pre-existing warnings), svelte-check 0 errors, vitest 103 + 186 passed, build OK.v0.44.0, docs chunk contains the newopenboot updatesection./,/docs/cli-reference,/docs/quick-start,/docs/env-vars,/docs/faq,/docs/what-is-openbootall 200; landing hero and cli-reference screenshots checked.prettier --check src/routes/+page.sveltefails identically onmain(JSON-LD block in<svelte:head>), not introduced here.