docs: add VS Code and Zed editor setup guide (#22)#26
Merged
Conversation
Document how to install and configure `lspf-hello` in VS Code and Zed: - Explain the workspace layout and that `lspf-hello` is an installable template server. - Add copy-paste VS Code `settings.json` (Generic LSP Client) and Zed `settings.json` snippets that launch `lspf-hello` for plain text. - Include the `cargo install --path crates/lspf-hello` command. - Add a Troubleshooting subsection (PATH, server not starting, reload). - Fix stale `examples/hello` references left over from the workspace migration. A doc-sync test (`crates/lspf-hello/tests/editor_docs.rs`) pins the snippets: it parses the VS Code and Zed JSON and asserts they reference the real `lspf-hello` binary and plaintext, so the copy-paste onboarding path can't silently rot. Closes #22 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Summary
Closes #22 — the VS Code / Zed MVP documentation work.
Adds an Editor setup section to the README so a user can install
lspf-helloand point VS Code or Zed at it without writing any code:lspf-hellois aninstallable template server.
settings.jsonsnippet (via the Generic LSPClient extension) launching
lspf-helloforplaintext.settings.jsonsnippet bindinglspf-helloto thebuilt-in Plain Text language.
cargo install --path crates/lspf-helloinstall command.PATH, server notstarting, and reloading the editor window after editing settings.
examples/helloreferences left over from the workspacemigration ([VS Code/Zed MVP] Migrate repository to Cargo workspace #20/refactor: migrate repository to Cargo workspace (#20) #24).
Test-driven (doc-sync)
The seam is the copy-paste correctness of the snippets. Added
crates/lspf-hello/tests/editor_docs.rs(written red-first) which:fails if they aren't valid, paste-able JSON;
lspf-hellobinary and theplaintext / Plain Text language;
This keeps the documented onboarding path from silently rotting if the
binary name or config shape ever changes.
Acceptance criteria
lspf-hellois an installable template server.settings.jsonsnippet launchinglspf-hellofor plain text.lspf-hello.cargo install --path crates/lspf-hello.Verification
cargo test --all-features --all-targets— all pass (neweditor_docsdoc-sync tests + existingsmokee2e tests).cargo clippy --all-targets --all-features -D warnings— clean.🤖 Generated with Claude Code