Integration of documentation for vale configuration and rules
I would like to add documentation that gets shown when hovering over certain keywords in vale configuration files and rules. This would look something like this: https://user-images.githubusercontent.com/8785025/234143355-c442cbbd-ffc8-445f-a9b8-c3756ac1a5c2.png This brings the plugin closer to delivering what vale-ls can provide without actually relying on executing vale-ls (the reasoning for not using vale-ls can be found here pablomxnl/vale-cli-plugin#35) My current idea for the implementation is to take the documentation folder from vale-ls, put it in this project's resources, and show the documentation at appropriate places. During the implementation, I would like to imlpement an approach that would allow us to put a new "doc" folder in the resources without any further code changes so that we can update the documentation at any point from vale-ls. https://github.com/errata-ai/vale-ls/tree/main/doc Files of interest for seeing how vale-ls handles the display of documentation: • src/server.rs (hover logic) • src/yml.rs (key → doc mapping)
issue