Open
Conversation
Add a concise "Keeping the CLI up to date" section to the CLI page covering the new `xcodebuildmcp upgrade` command, its `--check` and `--yes` flags, the npx caveat, and the non-interactive exit behavior. Update the Installation page to point at the self-update command instead of repeating per-channel upgrade instructions. Also record an Audience and voice rule in CLAUDE.md: docs are for end users of XcodeBuildMCP, not contributors working on the implementation, so drafts should focus on usage and user-impacting behavior rather than internal mechanics (per-channel lookup strategies, fetch/parse details, timeouts, etc.). The revised upgrade docs follow this rule. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Adds documentation for the new
xcodebuildmcp upgradeself-updatecommand landing in getsentry/XcodeBuildMCP#348.
What changes
app/docs/_content/cli.mdx: adds anupgraderow to the top-levelcommands table and a new "Keeping the CLI up to date" section covering
the command, its
--checkand--yesflags, the npx caveat, and thenon-interactive exit behavior.
app/docs/_content/installation.mdx: replaces the per-channel "Upgradelater" blocks with a single pointer to
xcodebuildmcp upgrade, whichalready knows which package manager you installed with.
CLAUDE.md: records an "Audience and voice" rule directly under theDocs site section.
Why
The first draft leaned too far into implementation detail (which APIs
are called per channel, how release notes are fetched, truncation rules).
These docs are for end users of the CLI, not contributors working on the
XcodeBuildMCP implementation, so the revised pass covers only what the
user needs to decide and how to use the command. The CLAUDE.md rule
captures that guidance so future authors do not drift back to
implementation-heavy prose.
Note: the XcodeBuildMCP PR is not merged yet, so this depends on the
upgradecommand actually shipping. Hold merging this until that lands.