Skip to content

Feature/p8 t2 restructure docc canonical#6

Merged
SoundBlaster merged 8 commits into
mainfrom
feature/P8-T2-restructure-docc-canonical
Feb 8, 2026
Merged

Feature/p8 t2 restructure docc canonical#6
SoundBlaster merged 8 commits into
mainfrom
feature/P8-T2-restructure-docc-canonical

Conversation

@SoundBlaster
Copy link
Copy Markdown
Owner

Description

Restructure and rename the Swift Package Manager (SPM) project and DocC documentation from mcpbridge-wrapper to XcodeMCPWrapper. This change aligns the p
ackage name with the repository name and follows Apple's canonical Swift Package Manager structure for documentation.

Key changes:

  • Renamed package in Package.swift from mcpbridge-wrapper to XcodeMCPWrapper
  • Renamed targets: mcpbridge-wrapperXcodeMCPWrapper, mcpbridge-wrapper-docsXcodeMCPWrapper-docs
  • Moved DocC catalog to canonical location: Sources/XcodeMCPWrapper/Documentation.docc/
  • Updated main DocC page with new symbol reference: XcodeMCPWrapper.md
  • Updated GitHub Actions workflow with new paths and target names
  • Fixed scripts/check_doc_sync.py to reference new DocC paths
  • Fixed pyproject.toml repository URLs
  • Updated CONTRIBUTING.md with new DocC path reference

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactoring
  • CI/CD improvement

Quality Gates

Before submitting, ensure all quality gates pass:

make check

Or run individually:

  • make test - All tests pass with ≥90% coverage
  • make lint - No linting errors
  • make format - Code is properly formatted
  • make typecheck - Type checking passes
  • make doccheck - Documentation is synced with DocC (if docs changed)

Documentation Sync

If you modified files in docs/, ensure corresponding DocC files are also updated:

docs/ file                      DocC file
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
docs/installation.md            Sources/XcodeMCPWrapper/Documentation.docc/Installation.md
docs/cursor-setup.md            Sources/XcodeMCPWrapper/Documentation.docc/CursorSetup.md
docs/claude-setup.md            Sources/XcodeMCPWrapper/Documentation.docc/ClaudeCodeSetup.md
docs/codex-setup.md             Sources/XcodeMCPWrapper/Documentation.docc/CodexCLISetup.md
docs/troubleshooting.md         Sources/XcodeMCPWrapper/Documentation.docc/Troubleshooting.md
docs/architecture.md            Sources/XcodeMCPWrapper/Documentation.docc/Architecture.md
docs/environment-variables.md   Sources/XcodeMCPWrapper/Documentation.docc/EnvironmentVariables.md
README.md                       Sources/XcodeMCPWrapper/Documentation.docc/XcodeMCPWrapper.md
  • Documentation changes are synced with DocC catalog (or N/A)

Testing

  • Added/updated tests for new functionality
  • All tests pass locally
  • Manually tested the changes

DocC build verified locally:

swift package generate-documentation --target XcodeMCPWrapper \
--output-path ./.docc-build \
--transform-for-static-hosting \
--hosting-base-path XcodeMCPWrapper

✅ Builds successfully with no errors.

Checklist

  • Code follows the project's style guidelines
  • Self-review completed
  • Comments added for complex code
  • Documentation updated (if needed)
  • No new warnings generated
  • PR title is descriptive

- Move DocC catalog from root-level to Sources/mcpbridge-wrapper/Documentation.docc/
- Create enhanced main landing page (McpbridgeWrapper.md) with topics organization
- Update GitHub Actions workflow with new documentation paths
- Preserve all existing documentation content
- All quality gates pass (pytest 95%, ruff, mypy, DocC build)
- Rename package and targets in Package.swift
- Rename Sources/mcpbridge-wrapper/ to Sources/XcodeMCPWrapper/
- Rename Sources/mcpbridge-wrapper-docs/ to Sources/XcodeMCPWrapper-docs/
- Update DocC main page to XcodeMCPWrapper.md with new symbol reference
- Update GitHub Actions workflow with new target and paths
- Update scripts/check_doc_sync.py with new DocC paths
- Update CONTRIBUTING.md with new DocC path
- Fix Sources/XcodeMCPWrapper-docs/main.swift URL
- Fix pyproject.toml repository URLs
@SoundBlaster SoundBlaster merged commit b999c24 into main Feb 8, 2026
9 checks passed
@SoundBlaster SoundBlaster deleted the feature/P8-T2-restructure-docc-canonical branch February 8, 2026 17:14
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