-
Notifications
You must be signed in to change notification settings - Fork 136
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
Decide what to do about the RxJS documentation #247
Comments
I agree. I find the accordion to be quite horrible to be honest. I think on each operator doc page we should just link to the corresponding RxJS operator doc page. I also think we should do the same for RxJava, since when I'm using RxJava I always go to the official JavaDoc page instead of reactivex.io. Opinions? @Blesh |
By the way, I was in the middle of updating the accordion to match RxJS v5 operators (see https://github.com/staltz/reactivex.github.io/commits/rxjs5) but I aborted that plan to work solely on reactivex.io/rxjs, because maintaining the accordion would be always duplicate work, framed in a worse format, and susceptible to becoming easily outdated. |
The RxJava / RxGroovy accordion sections for the operators already include One thing that's nice about the reactivex.io site compared to the javadocs On Fri, May 20, 2016 at 3:58 AM, André Staltz notifications@github.com
David M. Gross |
This sounds fine to me. I guess I'm not sure what the conflicting proposals here are. |
As a newcomer to the rx world, I happen to think that the documentation here is easier to understand than the docs at rxjs. For a quick overview of how an operator works I come here, and if further detail is needed I go there. The diagrams and explenations are much better here. |
the RxJS team have pursued their own documentation path and are doing some great work (http://reactivex.io/rxjs/). Does it still make sense to try to maintain our parallel documentation here? Currently we have RxJS accordion sections for all of the operator pages, for instance, but those aren't being maintained by the RxJS team. Maybe they should just link to the documentation at http://reactivex.io/rxjs/.
The text was updated successfully, but these errors were encountered: