P7-T5: Document the simplest supported broker UX and failure recovery flow#163
Merged
Conversation
…ure recovery flow
…s with quickstart-first and failure recovery sections
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a new
docs/quickstart.mdend-to-end guide and restructuresdocs/broker-mode.mdto lead with a quickstart-first layout and a dedicated failure recovery section. Updatesdocs/troubleshooting.mdto reference the new quickstart and surface--doctoras 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--tuidocs/broker-mode.md: new "Quick setup (recommended path)", "Verify it is working", and "Failure recovery" sections prepended before all existing detail; all prior content preserveddocs/troubleshooting.md: added first-time setup callout at top referencing quickstart; added--doctoras first step in the "Could not connect to broker socket" sectionType of Change
Quality Gates
Before submitting, ensure all quality gates pass:
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 formattedmake typecheck- Type checking passesmake 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/installation.mdmcpbridge-wrapper.docc/Installation.mddocs/cursor-setup.mdmcpbridge-wrapper.docc/CursorSetup.mddocs/claude-setup.mdmcpbridge-wrapper.docc/ClaudeCodeSetup.mddocs/codex-setup.mdmcpbridge-wrapper.docc/CodexCLISetup.mddocs/troubleshooting.mdmcpbridge-wrapper.docc/Troubleshooting.mddocs/architecture.mdmcpbridge-wrapper.docc/Architecture.mddocs/environment-variables.mdmcpbridge-wrapper.docc/EnvironmentVariables.mdREADME.mdmcpbridge-wrapper.docc/mcpbridge-wrapper.mdNote: No DocC catalog (
mcpbridge-wrapper.docc/) exists in this repository — DocC sync is N/A.Testing
Checklist