Update other-editors.scrbl to include langserver #4924
Conversation
|
see also #4925 |
|
Two notes: I personally would not include capabilities of the language server in a discussion about setting up your editor. That's really a detail of the language server and I wouldn't want to update that every time the language server is capabilities change or grow. Second note is I don't believe bracket language server is under active development. If I remember correctly it is stalled and the maintainers have said so in an issue somewhere. |
Done |
| @section{racket-langserver} | ||
|
|
||
| The @tt{racket-langserver} is a @hyperlink["http://langserver.org/"]{Language Server Protocol} | ||
| implementation for Racket. This project seeks to use @hyperlink["https://github.com/racket/drracket"]{DrRacket's public APIs} |
There was a problem hiding this comment.
If you want a link here, I think it should be @seclink[#:indirect? #t #:doc '(lib "scribblings/drracket-tools/drracket-tools.scrbl") "top"]{DrRacket's public APIs}.
|
|
||
| @section{racket-langserver} | ||
|
|
||
| The @tt{racket-langserver} is a @hyperlink["http://langserver.org/"]{Language Server Protocol} |
There was a problem hiding this comment.
This should use https.
| @subsection{Atom} | ||
|
|
||
| You can use the @hyperlink["https://github.com/cfinegan/atom-ide-racket"]{atom-ide-racket} package. The language | ||
| server will be automatically installed when @tt{atom-ide-racket} installs. |
There was a problem hiding this comment.
Since Atom was discontinued over a year ago, I'd be inclined not to mention it here.
There was a problem hiding this comment.
I don't think The Racket Guide should provide all of these details. Instead, I think the first step should be to contribute Scribble documentation to https://github.com/jeapostrophe/racket-langserver (which may require a decision from its maintainers about how to structure the packaging to minimize dependencies). Then, I think the guide should get something like a @section{Other Editors via the Language Server Protocol} that indirect-links to the new racket-langserver documentation.
In particular, The Racket Guide is part of the Racket release cycle, and racket-langserver is not. Running raco pkg install racket-langserver will install the latest release of the package, not the version from the date of the Racket release, so it makes sense to link to documentation matching the package actually being installed.
add @seclink[#:indirect? #t #:doc '(lib "scribblings/drracket-tools/drracket-tools.scrbl") "top"]{DrRacket's public APIs}
drop atom , add https
an initial PR has been created at jeapostrophe/racket-langserver#130 That said, I believe this is a pragmatic change that will enhance the experience for new Racket users. |
| @subsection{Installation and usage} | ||
|
|
||
| A Racket runtime is a prerequisite, so before using @tt{racket-langserver}, ensure that a Racket runtime | ||
| is installed. You can install an from the @hyperlink["https://download.racket-lang.org"]{official download page} |
|
Perhaps there should be a Newbie guide that includes such details. |
@mfelleisen I see 'getting started' as the newbie guide. #4925 adds a link to the editors chapter. |
|
@mfelleisen is there any barrier to this PR ?
I don't want it hanging around like a bad smell. I won't be creating an newbie guide today. if you like this PR can be considered an interim measure until a newbie guide is created. |
Checklist
Description of change
add Racket-langserver to https://docs.racket-lang.org/guide/other-editors.html