Fix README's command list and trim duplicated detail - #64
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.
Member
Author
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 #63. Merge #62 and #63 first.
Fixes a wrong command list. README's API group list named
rasterarrays,static-images,static-tilesandtilequery, none of which the binary has, and left outstatic. It also never mentioneddoctor,usageorconfig. The list is corrected, and a new Diagnostics and settings section shows those three plushistory.Adds a check so it can't drift again. Two tests in
tests/docs_contract.rs:every_command_the_readme_spells_exists: everymapbox …line in a shell block or inline code span must name a real command frommapbox --schema.every_top_level_command_appears_in_the_readme: every top-level command appears at least once.Run against #63's README, they report exactly the four fake groups and the three missing commands. They also catch a typo in a nested subcommand (
styles draft gett). The check is in its own commit, so reverting the README commit shows it failing.Trims duplicated detail. Agent skills, completion, generate-skills and Tileset CLI are cut to examples plus a link, since
docs/commands.mdcovers each fully. Implementation notes are gone (e.g. whyagent-skillshas no lock file), and the PowerShell aside is shorter. The installer-test note moves to CONTRIBUTING.md. Update notices, history, logs and Privacy stay as they were:docs/commands.mdlinks to the README for the first three, and Privacy is legal text.Not checked: the new tests only cover command paths, not flags or descriptions in README prose.
Unrelated but 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 (for examplemapbox usage --help). I left it alone in case that's intentional.