add documentation #2

gilice · 2022-12-11T16:50:42Z

No description provided.

README.md

maxpetts · 2022-12-21T15:45:27Z

LGTM 👍

Added a few suggestions to circumvent a few issues I ran into following this guide, but I've now got the plugin loading into Lapce. Thanks for taking the time to add.

@panekj what do you think?

Co-authored-by: Max Petts <[email protected]> Signed-off-by: gilice <[email protected]>

gilice · 2022-12-21T16:22:39Z

thank you @maxpetts . I updated the branch with your changes included, too.

panekj · 2022-12-21T16:26:13Z

I'm not interested in maintaining documentation of the template as most of the things presented in this PR will be explained in Lapce documentation once the plugin API stabilises, or it goes over the board of explaining what each thing is/does.
I won't mind a short description/reference list of required toolset to develop plugins (cargo, cargo-make, wasm-wasi32 toolchain) based on this repository.

maxpetts · 2022-12-21T21:29:35Z

I'm not interested in maintaining documentation of the template as most of the things presented in this PR will be explained in Lapce documentation once the plugin API stabilises, or it goes over the board of explaining what each thing is/does. I won't mind a short description/reference list of required toolset to develop plugins (cargo, cargo-make, wasm-wasi32 toolchain).

Ok that's understandable if the plugin API is subject to change. Perhaps we should omit the majority of the readme to just be:

Installing prerequisites (rust/cargo, cargo make, wasm-wasi32 target)
Running project (cargo make dev)

However, I believe the plugin folder structure should be documented, as this necessary to actually get Lapce to use the plugin - we could include a working as of 21/12/22 tag; just to avoid the future maintenance requirement by yourself?

panekj · 2022-12-27T01:43:22Z

we could include a working as of 21/12/22 tag; just to avoid the future maintenance requirement by yourself?

That still puts burden of maintenance on me

However, I believe the plugin folder structure should be documented, as this necessary to actually get Lapce to use the plugin

I believe it shouldn't as there is nothing to document? Plugins (and not only) directory paths should not be relied on and it should be opened via Lapce.