Repository navigation
docs: align site copy with the current CLI - #35
Merged
Merged
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! |
4 of 5 tasks
fullstackjam
changed the title
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
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.
The site still described removed install behavior and incorrectly said that
openboot updatewas unavailable. Align the documentation and homepage installer demo with the current released CLI, checked against v1.0.5 (bb075fbdce8dbebd51c8d2145715cbc125a0e2ad).openboot installto start setup and describe the current preset-selection flow.openboot update, including tap refresh on Homebrew installs, direct-binary version pins and backups, and opt-in automatic upgrades.install --update, doctor checks, and environment variable behavior. Pass the dry-run variable to the shell executing the installer, and clarify thatOPENBOOT_DOTFILESdoes not override remote-config dotfiles settings.Validation:
npm run validatepassed: ESLint 0 errors (223 existing warnings), Svelte checks 0 errors (4 existing warnings), 103 unit/architecture tests and 186 Workers/D1 tests passed, and production build succeeded. Staged Markdown passed Prettier andgit diff --checkpassed. The corrected environment-variable pipeline was exercised against the v1.0.5 installer in dry-run mode; it printed the plan and exited without installing. The built docs contain the update section anchor and revised copy.