Reorganize README, fix its command list, and check it against the binary - #63
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
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.
Stacked on #62. Merge that first.
Three commits:
1. Reorganize sections. The README now follows what a reader does: install, log in, run commands. Text is moved, not rewritten.
every_telemetry_marker_is_disclosednow finds it by## Privacy. I checked that it still fails when a disclosure is removed and when the section is missing.2. Check README's commands against the binary. Two tests in
tests/docs_contract.rs:mapbox …in a shell block or inline code span must be a real command frommapbox --schema.Run against the README before commit 3, they report the four fake groups and the three missing commands below. They also catch a typo in a nested subcommand (
styles draft gett).3. Fix the command list and trim.
rasterarrays,static-images,static-tilesandtilequery, which the binary doesn't have, and left outstatic.doctor,usageandconfigweren't mentioned; a new Diagnostics and settings section covers them.docs/commands.mdcovers each fully. Implementation notes are gone, and the installer-test note moves to CONTRIBUTING.md.docs/commands.mdlinks to the README for the first three, and Privacy is legal text.Not checked: the new tests cover command paths only, not flags or descriptions in README prose.
Unrelated, found along the way:
REPO_URLinsrc/main.rsandrepositoryinCargo.tomlpoint atgithub.com/mapbox/cli, which redirects tomapbox/cli-opensource-preview, not this repo. It shows up in help text such asmapbox usage --help. Left alone in case it's intentional.