rsocket / rsocket-java

Java implementation of RSocket
http://rsocket.io
Apache License 2.0
2.36k stars 354 forks source link

Where is the 'reference doc' ? #1054

Open kdvolder opened 2 years ago

kdvolder commented 2 years ago

When I report a issue, there's a prompt about 'Documentation issues' as reporting issues with the 'reference docs' or the 'api Java doc'. But as to the reference docs... I am not even sure they exist. If they do exist... couldn't find them. Places where I looked:

So either I'm not looking in the right places, or RSocket Java doesn't come with any real 'reference docs'.

Documentation Issue

If any reference documentation / in-depth tutorial material exists on how to get started using RSocket java, then the issue is that it is simply too hard to find. If it doesn't exist... then that is the issue. This is an issue especially for an api that is really a bit too complex that I don't think its realistic for most folks to just pick up and use the api without at least some background intro / guidance.

Improvement Suggestion

Either create a decent 'official' tutorial, or, if it already exist, provide a link from the github main readme (which seems to be the natural place where someone like me, looking for info on RSocket Java libs seems to end up looking for that sort of thing).