Edit README - #2337
Open
Guillermo López-Anglada (guillermooo) wants to merge 15 commits into
Open
Conversation
Guillermo López-Anglada (guillermooo)
force-pushed
the
users/guillermo/edit-readme
branch
2 times, most recently
from
August 24, 2026 06:32
e2b74ee to
bf3adb6
Compare
Guillermo López-Anglada (guillermooo)
force-pushed
the
users/guillermo/edit-readme
branch
from
August 24, 2026 06:37
bf3adb6 to
cd993ce
Compare
Guillermo López-Anglada (guillermooo)
marked this pull request as ready for review
August 24, 2026 06:42
Guillermo López-Anglada (guillermooo)
requested a review
from a team
as a code owner
August 24, 2026 06:42
Copilot started reviewing on behalf of
Guillermo López-Anglada (guillermooo)
August 24, 2026 06:42
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the README for clearer project positioning, installation guidance, and LSP connection instructions.
Changes:
- Converts long URLs to reference-style links.
- Adds automated and manual installation guidance.
- Clarifies named-pipe and stdio capabilities and usage.
Suppressed comments (2)
README.md:149
- Correct the
stdiotypo so readers can find the intended configuration type.
For examples of tested sdtio-based configurations, see:
README.md:60
- Both installation subsections skip heading level three, which gives assistive navigation an incorrect hierarchy. Use level-three headings directly beneath
## Installation.
#### Automated Installation
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Looks worse but apparently improves the doc's usability.
Apparently the correct term is 'best efforts' but whatever.
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.
PR Summary
A few edits to the first half of the README.
Note
Best reviewed by commit.
The new Installation section (44d9732) should be reviewed for factual accuracy.
PR Context
Use reference-style links for long links, edit for conciseness and clarity, add installation information.