Feature Matrix/Design Documents

[ahmedneilhussain]

I have been pondering adding a companion document to the top-level README to give an overview of the new API and also the concurrency considerations that underpin it. There was some useful discussion that was captured over the course of the various PRs which would be worth capturing to help people understand what is going on so that future maintenance doesn't break the guarantees (and is equipped to fix any flaws!)

That then extended into thinking it might be useful to having a broad overview of the structure of the plugin and how it works.

A related point is that although LSP4e isn't a complete implementation of the protocol, the feature set is already very rich. I have discovered whole swathes of functionality that I was unaware of, partly through not realising how it was triggered through the UI. There's also the issue that there's not always a standard terminology for 'things a language-aware IDE can do', so the translation from LSP-speak to Eclipse-speak isn't always obvious.

Would there be any value in a feature matrix showing LSP feature, level of support by LSP4e, key classes, and how to trigger through the UI? What do people think? Too bureaucratic/too much effort to maintain?