Skip to content

docs: Add architecture-debugging and schema-versioning pages#5

Merged
cameroncooke merged 1 commit intomainfrom
docs/architecture-debugging-and-schema-versioning
Apr 25, 2026
Merged

docs: Add architecture-debugging and schema-versioning pages#5
cameroncooke merged 1 commit intomainfrom
docs/architecture-debugging-and-schema-versioning

Conversation

@cameroncooke
Copy link
Copy Markdown
Collaborator

Summary

Add two new contributor pages and align tool-authoring with the upstream XcodeBuildMCP docs migration PR, which deletes the in-repo docs/ tree in favor of this site.

  • New page: /docs/architecture-debugging — simulator debugger tools, debug session lifecycle, DAP and LLDB CLI backends. Replaces docs/DEBUGGING_ARCHITECTURE.md / docs/dev/DAP_BACKEND_IMPLEMENTATION_PLAN.md.
  • New page: /docs/schema-versioning — how structured-output JSON Schemas are versioned and published. Replaces docs/SCHEMA_VERSIONING.md.
  • Register both slugs in _content/index.ts, _data/routes.ts (DocSlug, PAGES_ORDER, PAGE_META, SIDEBAR_GROUPS), and add a "read this next" pointer from architecture.mdx to the debugging page.
  • Update tool-authoring.mdx to drop the removed npm run docs:update step and references to generated docs/TOOLS.md / docs/TOOLS-CLI.md.
  • app/page.tsx: route the homepage Contributing link to /docs/contributing instead of the deleted GitHub doc.

Test plan

  • npm run dev and visit /docs/architecture-debugging and /docs/schema-versioning — both render with TOC, scroll-spy, and sidebar entries under Contributing.
  • Sidebar shows the new entries in the documented order; the Architecture sub-group includes Debugging.
  • "Read this next" link from /docs/architecture -> /docs/architecture-debugging resolves.
  • /docs/tool-authoring no longer references docs/TOOLS.md or npm run docs:update.
  • Homepage "Contributing" CTA goes to /docs/contributing.
  • npm run build succeeds (no broken slug imports).

Add two new contributor pages, route them in, and align tool-authoring with
the upstream XcodeBuildMCP docs migration.

- New: app/docs/_content/architecture-debugging.mdx — covers simulator
  debugger tools, debug session lifecycle, and the DAP and LLDB CLI backends.
- New: app/docs/_content/schema-versioning.mdx — explains how structured
  output JSON Schemas are versioned and published.
- Register both pages in _content/index.ts, _data/routes.ts (DocSlug,
  PAGES_ORDER, PAGE_META, SIDEBAR_GROUPS), and link to architecture-debugging
  from architecture.mdx.
- Update tool-authoring.mdx: drop references to the removed
  `npm run docs:update` step and the generated `docs/TOOLS.md` /
  `docs/TOOLS-CLI.md` files.
- app/page.tsx: point the homepage Contributing link at /docs/contributing
  instead of the deleted GitHub doc.
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Apr 25, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
xcodebuildmcp-com Ready Ready Preview, Comment Apr 25, 2026 9:34pm

Request Review

@cameroncooke cameroncooke merged commit 347d001 into main Apr 25, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant