chore: add explanation on differences with runtimes #790
Conversation
This file contains 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
viktorsaws
reviewed
Feb 21, 2025
| @@ -2,6 +2,14 @@ | |||
|
|
|||
| Language servers for integration with IDEs and Editors | |||
|
|
|||
| ## Relation with Language Server Runtimes | |||
|
|
|||
| This monorepo hosts language servers created using the [Language Server Runtimes](https://github.com/aws/language-server-runtimes/tree/main/runtimes)'s Server Interface. This enables the servers to use features provided by the Runtimes in the same package. | |||
There was a problem hiding this comment.
Let's add a bit more explanation of what Runtime actually is. It may be very confusing for those, not familiar with the project
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.
Problem
There is no explanation on the relation between servers and runtimes, which causes confusion for developers new to the repo.
Solution
Add a brief explanation in the readme
License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.