Skip to content

Commit 2033dd0

Browse files
committed
docs: Migrate documentation to xcodebuildmcp.com
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
1 parent c0e0e9a commit 2033dd0

59 files changed

Lines changed: 38 additions & 14179 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.cursor/BUGBOT.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
XcodeBuildMCP is an MCP server exposing Xcode / Swift workflows as **tools** and **resources**.
66
Stack: TypeScript · Node.js · plugin-based auto-discovery (`src/mcp/tools`, `src/mcp/resources`).
77

8-
For full details see [README.md](README.md) and [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md).
8+
For full details see [README.md](README.md) and [Architecture](https://xcodebuildmcp.com/docs/architecture).
99

1010
---
1111

@@ -55,8 +55,9 @@ export const handler = (p: FooBarParams) => fooBarLogic(p);
5555

5656
## 4. Documentation Checklist
5757

58-
* `docs/TOOLS.md` must exactly mirror the structure of `src/mcp/tools/**` (exclude `__tests__` and `*-shared`).
59-
*Diff heuristic*: if a PR adds/removes a tool but does **not** change `docs/TOOLS.md`**warning**.
58+
* Tool manifests, schemas, and implementations must stay aligned when tools are added, removed, or renamed.
59+
*Diff heuristic*: tool changes without corresponding manifest/schema/fixture updates ⇒ **warning**.
60+
* Public tool docs live at https://xcodebuildmcp.com/docs/tools and are synced from release data; do not require static in-repo tools-doc parity.
6061
* Update public docs when CLI parameters or tool names change.
6162

6263
---
@@ -76,7 +77,7 @@ export const handler = (p: FooBarParams) => fooBarLogic(p);
7677

7778
1. **External-boundary violations**: confirm tests use injected executors/filesystem for external side effects.
7879
2. **DI compliance**: check direct `child_process` / `fs` imports in MCP tool logic; standalone utilities with simple commands are acceptable.
79-
3. **Docs accuracy**: compare `docs/TOOLS.md` against `src/mcp/tools/**`.
80+
3. **Docs accuracy**: compare tool manifests, schemas, fixtures, and implementation changes; public tool docs are generated at https://xcodebuildmcp.com/docs/tools.
8081
4. **Style**: ensure ESLint and Prettier pass (`npm run lint`, `npm run format:check`).
8182

8283
---

.github/workflows/tool-authoring-guidance.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,15 @@ jobs:
7676
7777
${fileList}${hiddenText}
7878
79-
Please review the [Tool Authoring Cookbook](https://github.com/${owner}/${repo}/blob/main/docs/dev/TOOL_AUTHORING_COOKBOOK.md) before merging.
79+
Please review the [Tool Authoring guide](https://xcodebuildmcp.com/docs/tool-authoring) before merging.
8080
8181
Checklist:
8282
- Run \`npm run test:snapshots\` for any added, modified, or deleted tool.
8383
- If fixtures need to change, regenerate them with \`npm run test:snapshots:update\` and review the diff.
8484
- Add, update, or remove the matching MCP, CLI, and JSON fixtures for the changed tool surface.
8585
- Run \`npm run test:schema-fixtures\` after changing structured output schemas or JSON fixtures.
86-
- Keep tool manifests, workflow manifests, output schemas, structured content, generated docs, and fixtures aligned.
87-
- If you changed tool metadata, run \`npm run docs:update\` and \`npm run docs:check\`.
86+
- Keep tool manifests, workflow manifests, output schemas, structured content, and fixtures aligned.
87+
- If you changed tool metadata, run \`npm run docs:check\`.
8888
8989
Snapshot tests are intentionally not a required PR gate because they are slow and environment-sensitive. This reminder exists so contributors know when they need to run them locally for tool additions, changes, and removals.`;
9090

AGENTS.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ When reading issues:
2828
- Technical prose only, be kind but direct (e.g., "Thanks @user" not "Thanks so much @user!")
2929

3030
## Docs
31-
- If modifying or adding/removing tools run `npm run docs:update` to update the TOOLS.md file, never edit this file directly.
3231
-
3332
### Changelog
3433
Location: `CHANGELOG.md`
@@ -61,7 +60,7 @@ Use these sections under `## [Unreleased]`:
6160
- Do NOT just kill the run — first inspect the process tree (`ps -ef | grep -E "vitest|xcodebuild|simctl|devicectl"`) to identify what's stuck.
6261
- Common hang causes: locked physical device, stale simulator state, `devicectl diagnose` waiting for password, orphaned daemon process.
6362
- Capture what you find before killing, so the root cause can be fixed rather than papered over.
64-
- If physical-device snapshot tests hang after the final test summary, the likely cause is Apple post-failure diagnostics invoking `devicectl diagnose`, which may prompt for a macOS password and wedge in automated runs; see `docs/dev/device-snapshot-password-hang-rca.md`.
63+
- If physical-device snapshot tests hang after the final test summary, the likely cause is Apple post-failure diagnostics invoking `devicectl diagnose`, which may prompt for a macOS password and wedge in automated runs.
6564

6665
## **CRITICAL** Tool Usage Rules **CRITICAL**
6766
- NEVER use sed/cat to read a file or a range of a file. Always use the native read tool.

CLAUDE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ When reading issues:
2828
- Technical prose only, be kind but direct (e.g., "Thanks @user" not "Thanks so much @user!")
2929

3030
## Docs
31-
- If modifying or adding/removing tools run `npm run docs:update` to update the TOOLS.md file, never edit this file directly.
3231
-
3332
### Changelog
3433
Location: `CHANGELOG.md`

NEXT_STEPS_MIGRATION_TODO.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)