-
Notifications
You must be signed in to change notification settings - Fork 7.6k
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
2.x: Update Getting started docs #6136
2.x: Update Getting started docs #6136
Conversation
JFrog: The main readme contains the proper links: https://github.com/ReactiveX/RxJava#binaries |
Codecov Report
@@ Coverage Diff @@
## 2.x #6136 +/- ##
============================================
+ Coverage 98.25% 98.26% +0.01%
+ Complexity 6197 6195 -2
============================================
Files 667 667
Lines 44853 44853
Branches 6213 6213
============================================
+ Hits 44069 44075 +6
+ Misses 237 235 -2
+ Partials 547 543 -4
Continue to review full report at Codecov.
|
Just copy in the from this inclusive to this exclusive.
Perhaps change the non-java examples into Java after all. However, since the text should also be reviewed for 2.x terminology, I don't recommend taking this one.
There links there should point to the various category-wiki pages, such as https://github.com/ReactiveX/RxJava/blob/2.x/docs/Creating-Observables.md#just most of such pages hasn't been updated yet. I'd leave this last.
Beyond verifying the existing links, one should vet the various blog posts. Some of the existing links should be also checked for how much they are version agnostic. I'd leave this to somebody with a longer history with RxJava. Perhaps the easiest next step is to work on one of the operator-category listings such as https://github.com/ReactiveX/RxJava/blob/2.x/docs/Filtering-Observables.md - review, remove nonexistent operators, fancy like #6131 |
@akarnokd Thanks for the next steps. Will pick them. Anything more to be done on this PR? |
We can always expand it later, the important changes are already okay with it. |
Yes. That's true. Looking forward to it. |
This patch the following changes to the Getting started docs as per Issue No: #6132
Questions:
Looks like JFrog for RxJava 2 is broken or invalid now. Can we add Jitpack?Getting started from readme.md
. Although,How to use RxJava
orAlphabetical List of Operators
,Additional-Reading.md
can be great next steps.