docs: clarify Homebrew update vs upgrade for canton-devkit - #343
Merged
Merged
Conversation
Operators often pass a formula name to brew update and miss new releases; document the correct refresh-then-upgrade flow.
Tighten the upgrade wording and normalize nearby markdown table formatting so the install guide stays consistent.
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.
Summary
Clarify how to upgrade canton-devkit via Homebrew so operators do not confuse
brew updatewithbrew upgrade, and document the recommendedbrew update && brew upgrade canton-devkitflow.Changes
docs/homebrew.md(updatevsupgrade, wrongbrew update canton-devkitusage, one-liner, already-installed case, version checks)docs/getting-started.mdwebsite/docs-map.mjsTest plan
make test/make lintrequired)brew update && brew upgrade canton-devkitmatches local Homebrew behaviorChecklist
website/synced if any mirroreddocs/*.mdchanged)TODO(#issue)comment) (N/A)