Integrations documentation improvements

[mcecode]

Update: For anyone stumbling on to this discussion at a later time, the changes described here have already been implemented in #755.

---

I was planning to update the official VS Code docs by transferring some of the info in the extension's readme, like the "Commands" table, and by moving the development guide to the "Contributors" section in the official documentation. While doing so, I thought of other things that could be changed in our docs. I just want to run by some of them here so I can be sure that they're welcome changes:

• Remove non-Neovim specific installation methods in the Neovim page and opt to link to the language server installation section instead. This would put installation instructions in a centralized place, which would mean less redundancy and chances of having installation methods in one and not the other. For example, we currently have installation instructions for Nixpkgs in the language server page but not in the Neovim page.
• Transfer the configuration section explanations from the Neovim page to a new configuration section in the language server page, and leave only a sample config in the Neovim page with a link to the language server configuration section for readers that want further details. I understand that Neovim is our first-class citizen, but I think this will make our configs more transparent to users of other editors, in that they don't have to convert Neovim configs to their editor's configs. I don't think this will detract a lot from Neovim users since the sample config would still be there, the explanations would just be in a different page.
• Improve the Helix and Emacs pages
  • Add link to language server installation instructions
  • Add sample config, based on the community discussions thus far, with a link to the aforementioned new configuration section in the language server page

[elijah-potter]

Remove non-Neovim specific installation methods in the Neovim page and opt to link to the language server installation section instead. This would put installation instructions in a centralized place, which would mean less redundancy and chances of having installation methods in one and not the other. For example, we currently have installation instructions for Nixpkgs in the language server page but not in the Neovim page.

Agreed. You're not the first one to comment on this.

Transfer the configuration section explanations from the Neovim page to a new configuration section in the language server page, and leave only a sample config in the Neovim page with a link to the language server configuration section for readers that want further details. I understand that Neovim is our first-class citizen, but I think this will make our configs more transparent to users of other editors, in that they don't have to convert Neovim configs to their editor's configs. I don't think this will detract a lot from Neovim users since the sample config would still be there, the explanations would just be in a different page.

Absolutely. One thing though: moving forward, Neovim is no longer the only first-class citizen. In the past, Neovim has had the best support because that's what I use on a daily basis. When issues arose, I simply wasn't aware of them. Since we have more community engagement with other platforms now, I don't see any reason we should prioritize them any longer. This is especially true for configs and stuff, since that doesn't require any modifications to code.

If you'd like to open a pull request for these changes, I'd be happy to contribute.

[mcecode]

Cool, thanks for being open to these changes. I'll open a draft PR within the next few days starting with the VS Code changes I mentioned and work my way through the list. I'm quite slow when it comes to writing/editing docs so please be patient with me :)

[elijah-potter]

No rush at all. Thanks for reaching out about it!

[ficcdaf]

I'll be looking out for that as well! Once I see the structure you're going for, I can add some better Helix integration documentation as well.