Document Homebrew install, reorganize README, and check it against the binary - #62
Merged
Merged
Conversation
The README listed four API groups (rasterarrays, static-images, static-tiles, tilequery) the binary no longer has, and never mentioned doctor, usage or the real static group. Nothing read the README, so nobody noticed.
zmofei
added this pull request to stack #65
September 29, 2026 09:35
zmofei
changed the title
zmofei
removed this pull request from stack #65
September 29, 2026 12:08
mattpodwysocki
approved these changes
Sep 29, 2026
mattpodwysocki
left a comment
mattpodwysocki
left a comment
Contributor
There was a problem hiding this comment.
Checked the command-group list against a real --schema run: the four removed groups (rasterarrays, static-images, static-tiles, tilequery) genuinely don't exist anymore, and static, doctor, usage, config were genuinely missing. The two new docs_contract tests and the source_guards anchor fix pass, full suite is green, fmt/clippy clean.
One small nit, not blocking: the line starting "Each run appends one line to `~/.mapbox/history/..." under Command History runs much longer than the surrounding prose's usual wrap width. Might be worth a rewrap in a follow-up.
Approving.
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
2 participants
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.
Documents the Homebrew install, reorganizes the README around install → log in → run commands, and fixes its command list, which named four API groups the binary doesn't have and missed
static,doctor,usageandconfig.To keep that list from drifting again,
tests/docs_contract.rsnow checks that everymapbox …in the README is a real command and every top-level command is mentioned. It covers command paths only, not flags.Homebrew users get
brew upgrade/brew uninstallinstead ofmapbox uninstall, which would delete the binary out from under Homebrew. The update notice still suggests the curl installer; that's a code change for a separate PR.Docs and tests only, so no changelog entry.