docs: update vim docs to no longer point people to coc-metals #3819
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
|
My plan is to leave this open until we do the next release, and then merge it in right after. I'll wait for #3816 to be merged and then I'll rebase and update the contributing section with some new info specifically for |
ekrich
suggested changes
Apr 12, 2022
As of this next release [coc-metals](https://github.com/scalameta/coc-metals) will be officially deprecated, meaning we shouldn't be pointing people to it in the docs, and also shouldn't have all the features outlined be coc specific. This makes those changes. Note that this is much much more minimal than it previously was. This is mainly because the docs for `nvim-metals` are pretty spread out, and I don't have any intention of duplicating them. - The main docs are in https://github.com/scalameta/nvim-metals/blob/main/doc/metals.txt and they are in a specific format necessary for Vim help docs. - scalameta/nvim-metals#39 holds the example configuration - scalameta/nvim-metals#279 holds the feature list and instructions on how to utilize everything. All this is mentioned and linked on the vim page.
|
Now that the release is done is it alright to merge this? |
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.
As of this next release
coc-metals will be officially
deprecated, meaning we shouldn't be pointing people to it in the docs,
and also shouldn't have all the features outlined be coc specific. This
makes those changes.
Note that this is much much more minimal than it previously was. This is
mainly because the docs for
nvim-metalsare pretty spread out, and Idon't have any intention of duplicating them.
https://github.com/scalameta/nvim-metals/blob/main/doc/metals.txt and
they are in a specific format necessary for Vim help docs.
example configuration
feature list and instructions on how to utilize everything.
All this is mentioned and linked on the vim page.