Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Where is the 'reference doc' ? #1054

Open
kdvolder opened this issue Jul 4, 2022 · 0 comments
Open

Where is the 'reference doc' ? #1054

kdvolder opened this issue Jul 4, 2022 · 0 comments

Comments

@kdvolder
Copy link

kdvolder commented Jul 4, 2022

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:

  • the 'https://rsocket.io/' website. This seems more like a language agnostic 'marketing' site that is more about convincing people (why) we'd want to use RSocket (note however that in my book not finding information about the 'how' is a significant point against using something). I personally would be much more eager and enthusiastic about using RSocket if I can find good information on how to use it more easily.
  • https://github.com/rsocket/rsocket-java github repo (this the most natural place to get to when you come from rsocket.io and are looking into the 'Java implementation' of RSocket. The readme has a couple of quick paste snippets but really for an api as complex as RSocket is, that isn't all that helpful (well it is rather helpful, but it is really just the bare minimum).
  • THe wiki of this repo... but it is empty/non-existent
  • The best thing I have found so far is a third-party blog article on baeldung. https://www.baeldung.com/rsocket

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant