Mickael,
In the repo there is already doc folder containing outdated asciidoc documentation. I'll add the update documents there.
The doc folder could be a standalone mvn project, only to generate the documents to be linked to the LSP4E project page.
The effort should be minimal, given there are already asciidoc maven plugins available [#1].
Renaming is not important, but to build the mvn project, its name should be structured. Anyway, if this is not needed we can just stick to have asciidoc documentation with no doc generation.
In the documentation will be clear that you can have you language server built with any technology you want i.e. as Microsoft describes [#2], Xtext, or other.
As first example, I will add the xtext one. Then, when I find time, if this is a valuable idea, I could present also other options.
Indeed, it is clear the target audience are the people who want to develop LSP4E, and I think presenting concrete cases of integrating a LS in Eclipse could increase the interest in the project.
#1:
https://github.com/asciidoctor/asciidoctor-maven-examples
#2:
https://code.visualstudio.com/docs/extensions/example-language-server
2018-01-26 18:21 GMT+01:00 Mickael Istria <
mistria@xxxxxxxxxx>:
>
> Hi Patrik,
>
> On Fri, Jan 26, 2018 at 5:28 PM, Patrik Suzzi <
psuzzi@xxxxxxxxx> wrote:
>>
>> 1. add updated documentation in asciidoc format in the "doc" project
>
>
> You mean the "doc" folder?
> If so, no objection to include doc in the repo.
>
>>
>> 2. add a maven build that generates the mvn site for the project "doc"
>
>
> I don't think it's really necessary to go that far. Given that the target of
> LSP4E are Eclipse plugin developers, I don't think they need a generated
> site. Just some asciidoc files would work.
>
>>
>> 3. rename the "doc" project to "org.eclipse.lsp4e.doc"
>
>
> What would be the benefit of such rename?
>
>>
>> 4. Add a tutorial explaining how to create a language server with XText
>> and consume it with LSP4E.
>
>
> Ok, any example is welcome. That said, it's important to make the tutorial
> not sound like XText is mandatory and insisting on the approach being
> language agnostic.
>
> Overall, documentation is welcome, but keep in mind how much value is each
> of this task likely to provide, ie how many new adopters would LSP4E get. If
> some actions are questionable in term of value, we should consider delaying
> in favor or more profitable efforts.
>
> Cheers,
>
> _______________________________________________
> lsp4e-dev mailing list
>
lsp4e-dev@xxxxxxxxxxx
> To change your delivery options, retrieve your password, or unsubscribe from
> this list, visit
>
https://dev.eclipse.org/mailman/listinfo/lsp4e-dev
>
