elixir-ls icon indicating copy to clipboard operation
elixir-ls copied to clipboard
verified publisher icon elixir-lsp

Update readme and Emacs configuration docs

Open danirukun opened this issue 4 years ago • 3 comments

Mainly to reflect the addition of the new elixir-ls Brew formula.

  • Remove duplicated sections from readme
  • Add key info like install instructions in readme
  • Add more Emacs install info in the docsite
  • Add TOC to readme

danirukun avatar Jan 19 '22 22:01 danirukun

Also I think that the development guides in https://github.com/elixir-lsp/elixir-ls/tree/master/guides should probablly move into docs and be available in the docsite. Of course want to hear your comments about this idea.

danirukun avatar Jan 20 '22 20:01 danirukun

Why are you removing features documentation (Debugger, Workspace symbols etc.)?

lukaszsamson avatar Jan 23 '22 08:01 lukaszsamson

@lukaszsamson they are not removed, they have already been moved to the docsite. E.g. see https://elixir-lsp.github.io/elixir-ls/getting-started/vscode/#debugger and https://elixir-lsp.github.io/elixir-ls/features/

This is to keep the README clean and only have the most important info in it, and keep more detailed and searchable information on the docsite. This is pretty standard for other Language Server projects.

danirukun avatar Jan 23 '22 11:01 danirukun

@DaniruKun can you resolve conflicts

lukaszsamson avatar Oct 06 '22 15:10 lukaszsamson

Done

danirukun avatar Oct 09 '22 09:10 danirukun

Sorry I missed the update and the PR is once again out of date. Furthermore, the homebrew install is not supported

lukaszsamson avatar Jun 13 '23 18:06 lukaszsamson