docs: Migrate documentation to xcodebuildmcp.com#363
Merged
cameroncooke merged 1 commit intomainfrom Apr 25, 2026
Merged
Conversation
Move long-form documentation (architecture, configuration, tool authoring, debugging, schema versioning, etc.) from in-repo `docs/` to the public site at xcodebuildmcp.com. The in-repo TOOLS.md generation pipeline is removed in favor of the website's release-data-driven tool catalog. - Trim README.md to install + client setup; deeper guides now link to the site - Update AGENTS.md, CLAUDE.md, BUGBOT.md, and the tool-authoring workflow to reference site URLs instead of removed in-repo docs - Drop `docs:update` script + `update-tools-docs.ts` and remove `check-code-patterns.js`; `docs:check` now scans only README + CHANGELOG - Update SKILL.md and server tool-description text to point at site URLs - Stop including `docs/SKILLS.md` and `docs/GETTING_STARTED.md` in release.sh
6 tasks
commit: |
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
Move long-form documentation from in-repo
docs/to the public site at https://xcodebuildmcp.com. The website is now the single source of truth for end-user and contributor docs; the repo keeps onlyREADME.md,CHANGELOG.md, agent rules (AGENTS.md,CLAUDE.md), and.cursor/BUGBOT.md..github/workflows/tool-authoring-guidance.yml): point reviewers at https://xcodebuildmcp.com/docs/tool-authoring; drop thenpm run docs:updatestep.scripts/update-tools-docs.tsand thedocs:update/docs:update:dry-runnpm scripts (TOOLS.md is no longer generated).scripts/check-code-patterns.jsand its knip entry.scripts/check-docs-cli-commands.jsnow scans onlyREADME.md+CHANGELOG.md.scripts/release.shno longer touchesdocs/SKILLS.md/docs/GETTING_STARTED.md.skills/xcodebuildmcp/SKILL.mdand the server's tool-description block link to https://xcodebuildmcp.com/docs/configuration instead of the removeddocs/CONFIGURATION.md.docs/,docs/dev/,docs/investigations/, plus the top-levelNEXT_STEPS_MIGRATION_TODO.md. Equivalent content lives on the site (see companion site PR).Test plan
npm run lintnpm run docs:check(now scans README + CHANGELOG only)src/server/server.tsresolves on xcodebuildmcp.com.