P1-T13: Document stale editable install version mismatch in troubleshooting guide#166
Merged
SoundBlaster merged 10 commits intomainfrom Mar 10, 2026
Merged
Conversation
…in troubleshooting guide
… troubleshooting guide
…o troubleshooting docs
…_in_troubleshooting_guide (PASS)
There was a problem hiding this comment.
Pull request overview
This PR documents a common local-development failure mode where an editable install’s dist-info version becomes stale after bumping pyproject.toml, causing mcpbridge-wrapper --doctor to report a package/broker version mismatch, and it archives the completed task artifacts for P1‑T13.
Changes:
- Adds a new troubleshooting entry (and DocC mirror) explaining the stale editable-install version metadata and the fix (
pip install -e .). - Archives P1‑T13 workflow artifacts (PRD, validation report, review report) and updates Workplan/next/archive index bookkeeping.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| SPECS/Workplan.md | Adds completed task entry for P1‑T13 in the workplan. |
| SPECS/INPROGRESS/next.md | Records P1‑T13 as recently archived. |
| SPECS/ARCHIVE/P1-T13_Document_stale_editable_install_version_mismatch_in_troubleshooting_guide/P1-T13_Validation_Report.md | Adds validation report for the task. |
| SPECS/ARCHIVE/P1-T13_Document_stale_editable_install_version_mismatch_in_troubleshooting_guide/P1-T13_Document_stale_editable_install_version_mismatch_in_troubleshooting_guide.md | Adds archived PRD for the task. |
| SPECS/ARCHIVE/INDEX.md | Adds P1‑T13 entries to archive index and log. |
| SPECS/ARCHIVE/_Historical/REVIEW_p1_t13_editable_install_troubleshooting.md | Adds historical review report artifact for P1‑T13. |
| Sources/XcodeMCPWrapper/Documentation.docc/Troubleshooting.md | Adds DocC troubleshooting section for stale editable-install version mismatch. |
| docs/troubleshooting.md | Adds end-user troubleshooting entry (developer-scoped) describing symptom/cause/fix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
P1-T13and archive the task after rebasing onto currentmain.docs/troubleshooting.mdand sync the DocC mirror.Type of Change
Quality Gates
Before submitting, ensure all quality gates pass:
Or run individually:
make test- All tests pass with ≥90% coveragemake lint- No linting errorsmake format- Code is properly formattedmake typecheck- Type checking passesmake doccheck- Documentation is synced with DocC (if docs changed)Quality gate results:
pytest— PASS (902 passed, 5 skipped, 2 warnings)pytest --cov— PASS (91.55%total coverage)ruff check src/— PASSmypy src/— PASSmake doccheck-all— PASSDocumentation 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.mdTesting
Checklist