Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation on LSP #491

Closed
ndmitchell opened this issue Oct 11, 2020 · 2 comments · Fixed by #2517
Closed

Add documentation on LSP #491

ndmitchell opened this issue Oct 11, 2020 · 2 comments · Fixed by #2517
Labels
type: enhancement New feature or request

Comments

@ndmitchell
Copy link
Collaborator

We seem to have had a few beginners (both on the tracker and to me privately) confused by the LSP. In particular, its a protocol, and each editor implements it separately. That means what completions pop up is "the domain" of HLS, but the key to make them pop up is the editor. I think some more documentation focused on that aspect would be valuable.

Having read the prefix of the readme, I'm not sure it's that beginner friendly. The main questions I want to ask are what is this (it's a Haskell IDE), why might I want to use it (quite featureful), and how do I use it (quite far down the page). I'm not totally sure what it should look like, but I imagine we could do better...

@ndmitchell
Copy link
Collaborator Author

See https://github.com/haskell/ghcide/issues/658 for some more information.

@michaelpj
Copy link
Collaborator

There is a small amount about LSP in the doc that just got merged, but it covers the key concepts at least.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants