Skip to content

P7-T5: Document the simplest supported broker UX and failure recovery flow#163

Merged
SoundBlaster merged 8 commits into
mainfrom
feature/P7-T5-broker-ux-docs
Mar 7, 2026
Merged

P7-T5: Document the simplest supported broker UX and failure recovery flow#163
SoundBlaster merged 8 commits into
mainfrom
feature/P7-T5-broker-ux-docs

Conversation

@SoundBlaster
Copy link
Copy Markdown
Owner

Description

Adds a new docs/quickstart.md end-to-end guide and restructures docs/broker-mode.md to lead with a quickstart-first layout and a dedicated failure recovery section. Updates docs/troubleshooting.md to reference the new quickstart and surface --doctor as the first diagnostic step.

Task: P7-T5 — Document the simplest supported broker UX and failure recovery flow

Changes:

  • docs/quickstart.md (new): 5-step guide from prerequisites → broker daemon → client config → verify, with a concise failure recovery section using --broker-status, --doctor, and --tui
  • docs/broker-mode.md: new "Quick setup (recommended path)", "Verify it is working", and "Failure recovery" sections prepended before all existing detail; all prior content preserved
  • docs/troubleshooting.md: added first-time setup callout at top referencing quickstart; added --doctor as first step in the "Could not connect to broker socket" section

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 (898 passed, 91.75% coverage)
  • make lint - No linting errors (ruff check src/: all checks passed)
  • 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 mcpbridge-wrapper.docc/Installation.md
docs/cursor-setup.md mcpbridge-wrapper.docc/CursorSetup.md
docs/claude-setup.md mcpbridge-wrapper.docc/ClaudeCodeSetup.md
docs/codex-setup.md mcpbridge-wrapper.docc/CodexCLISetup.md
docs/troubleshooting.md mcpbridge-wrapper.docc/Troubleshooting.md
docs/architecture.md mcpbridge-wrapper.docc/Architecture.md
docs/environment-variables.md mcpbridge-wrapper.docc/EnvironmentVariables.md
README.md mcpbridge-wrapper.docc/mcpbridge-wrapper.md
  • Documentation changes are synced with DocC catalog (or N/A)

Note: No DocC catalog (mcpbridge-wrapper.docc/) exists in this repository — DocC sync is N/A.

Testing

  • Added/updated tests for new functionality
  • All tests pass locally (898 passed, 5 skipped, 2 warnings — no source changes)
  • Manually tested the changes

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

@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@SoundBlaster SoundBlaster merged commit f64eb60 into main Mar 7, 2026
10 checks passed
@SoundBlaster SoundBlaster deleted the feature/P7-T5-broker-ux-docs branch March 7, 2026 18:45
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