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

Horrible documentation #159

Closed
P1NG2WIN opened this issue Dec 17, 2020 · 4 comments
Closed

Horrible documentation #159

P1NG2WIN opened this issue Dec 17, 2020 · 4 comments

Comments

@P1NG2WIN
Copy link

P1NG2WIN commented Dec 17, 2020

Please improve your documentation.

Main page has info only about main scarlet dependency but mentions android-lifecycle, scarlet-websocket-okhttp and other depencencies which have to look in the maven page.

Main page links to outdated medium article

Demo app has unclear package naming (echo, gdax, root). Moreover, the demo app is generally very confusing and uses a lot of external libraries not related to scarlet, It is well-written in the open pr which offers another demo app

Main page has example only with rxjava, without coroutines

@james04gr
Copy link

Totally agree

@chnouman
Copy link

no doubt

@Dakrain
Copy link

Dakrain commented Dec 29, 2020

totally agree :) struggle to implement the library.

@aaronweihe
Copy link
Collaborator

I'd organize the folder structure to like

message-adapters/
  moshi/
  jackson/
  protobuf/
steam-adapters/
  rxjava2/
  coroutine/

to make it more obvious what those different artifacts are. and add README to each directory accordingly.

the medium link is fixed.

is #140 the "better" demo app you are referring to? if so, let's discuss there.

as for examples in corotuine, just created an issue #163 to track

PRs are always welcome if you have specific pain points.

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

5 participants