Repository navigation
docs(zed): explain local-checkout workaround for SSH projects - #1130
Merged
1 commit merged intoNov 6, 2026
Merged
1 commit merged into
1 commit merged into
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are recorded for the Zed SSH workaround documentation and accompanying regression test.
No open issues 🎉
What changed in this PR
Documents the local-checkout workaround for Zed native agents that cannot see MCP in SSH projects, addressing the setup confusion in #828 without adding remote MCP support.
Changes:
- Explains the local/remote settings mismatch and provides local install/build steps, synchronization caveats, and upstream references.
- Links the troubleshooting guidance from the platform guide.
- Adds a regression test for the guidance and its discoverability.
| File | Description |
|---|---|
| tests/test_documentation.py | Checks required Zed troubleshooting details and the platform-guide link. |
| docs/USAGE.md | Links SSH users to Zed troubleshooting. |
| docs/TROUBLESHOOTING.md | Documents symptoms, causes, and the local-checkout workaround. |
Review effort: Balanced
0160eb0
gowrishacv
pushed a commit
to gowrishacv/code-review-graph
that referenced
this pull request
Nov 6, 2026
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.
Note
AI-generated, not reviewed by a human. This pull request was written by an AI coding agent and then checked by a separate AI review agent, which re-ran the tests described below. No human has reviewed the code. It is submitted by @monsterlag, who runs these agents. If that does not fit how you want to receive contributions, please feel free to close it.
Linked issue
Related to #828; documents the maintainer's workaround without adding remote MCP support.
What & why
Running
install --platform zedon a remote host updates that host's user settings,not the local Zed instance. The generated server entry also points
cwdat thathost's checkout. The platform guide listed settings paths but did not explain this
mismatch.
Add a symptom/cause/fix entry with local-checkout install/build commands, explain
that the local graph does not include remote-only edits, and link it from the
platform guide. Link the upstream Zed reports for version-dependent remote behavior.
Add a documentation regression check for the guidance and its link.
How it was tested
Python 3.11.2, with environments, caches and test state isolated outside the checkout:
215 passed across the documentation/installer modules.
git diff --checkpassed.Earlier full-suite run (not repeated for this PR-text-only revision):
5,045 passed, 1 failed, 880 skipped, 3 xfailed, 2 xpassed; 86.66% coverage.
The failure,
test_hybrid_search_ranks_impact_radius_nodes_firstintests/test_e2e_real_repo.py, also reproduces on unchanged baseline code and dependson checkout-path length. Rechecking it during this revision produced the same failure.
No live Zed client or SSH end-to-end session was tested.
Checklist
uv run pytest tests/ --tb=short -q(baseline failure above)uv run ruff check code_review_graph/uv run mypy code_review_graph/ --ignore-missing-imports --no-strict-optionaldocs/, docstrings)