Skip to content

P1-T4: Update docs to reflect broker robustness improvements#129

Merged
SoundBlaster merged 9 commits into
mainfrom
feature/P1-T4-docs-broker-robustness
Mar 1, 2026
Merged

P1-T4: Update docs to reflect broker robustness improvements#129
SoundBlaster merged 9 commits into
mainfrom
feature/P1-T4-docs-broker-robustness

Conversation

@SoundBlaster
Copy link
Copy Markdown
Owner

Description

Update 5 docs/ files and 4 DocC mirror files to reflect the Phase 2 broker robustness improvements shipped in P2-T1 through P2-T5:

  • --broker flag (P2-T1) added to mode tables, client examples, migration guides, and topology sections. --broker-connect/--broker-spawn demoted to legacy aliases.
  • Stale socket auto-recovery (P2-T2) — limitations and troubleshooting sections updated; manual cleanup noted as only needed for --broker-connect.
  • JSON-RPC -32001 error (P2-T4) — "Could not connect" troubleshooting entries updated to show the actual error response format.
  • Web-UI mismatch warning (P2-T5) — new troubleshooting entry added: "Warning: broker is running without --web-ui on port N".

Files changed: docs/broker-mode.md, docs/troubleshooting.md, docs/cursor-setup.md, docs/claude-setup.md, docs/codex-setup.md, and their four DocC mirrors.

Follow-up tasks P1-T5 (Medium) and P1-T6 (Low) added to workplan for two remaining minor gaps found during review.

Type of Change

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

Quality Gates

  • make test - 737 passed, 5 skipped, 91.3% coverage (≥90% required)
  • make lint - ruff check src/ clean
  • make format - N/A (no source changes)
  • make typecheck - N/A (no source changes)
  • make doccheck - make doccheck-all passed across all scopes

Documentation Sync

  • Documentation changes are synced with DocC catalog
docs/ file DocC file Synced
docs/cursor-setup.md CursorSetup.md
docs/claude-setup.md ClaudeCodeSetup.md
docs/codex-setup.md CodexCLISetup.md
docs/troubleshooting.md Troubleshooting.md

Testing

  • Added/updated tests for new functionality — N/A (docs only)
  • All tests pass locally — 737 passed, 5 skipped
  • Manually tested the changes — N/A (docs only)

Checklist

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

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9d908a62ed

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread Sources/XcodeMCPWrapper/Documentation.docc/Troubleshooting.md
@SoundBlaster SoundBlaster merged commit c1999d1 into main Mar 1, 2026
10 checks passed
@SoundBlaster SoundBlaster deleted the feature/P1-T4-docs-broker-robustness branch March 1, 2026 11:05
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