Skip to content

A documentation project to shape marble diagrams into real-world examples.

License

Notifications You must be signed in to change notification settings

jingibus/RxChisel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 

Repository files navigation

RxChisel

A documentation project to shape marble diagrams into real-world examples.

The goal is to roughly mirror the structure of documentation at http://reactivex.io. For each concept, a concrete, real-world scenario will be shown, as well as how the operator implements it.

This is not intended to be an RxJava cookbook project. Instead, it is meant to supplement the existing marble documentation by showing readable real-world examples for each marble diagram.

Scope

For now, I am focusing on RxJava, with examples taken from the mobile domain.

Why? Well, I am an Android developer, and those are the kinds of scenarios I know.

Contributing

If you want to help out, then please bear in mind the following:

  1. The biggest thing I care about is how useful this is and how accurate these articles are. So Github issues regarding confusion or inaccuracy are always appreciated. Remember: if you're confused, it's not a failing on your part. It might not be a failing of RxChisel, either, but I'd certainly like to know regardless.
  2. If you would like to write something, please try to follow the structure followed so far. I would love nothing more than to be able to merge in quality writing.
  3. My writing is not being edited right now. So if you've got the chops to be an editor, I wouldn't turn that down, either.
  4. I am currently focused on the writing. If you have other non-writing ways to contribute — e.g. improving the presentation beyond a the current "pile of markdown files" structure — that would be a fantastic way to help out.

About

A documentation project to shape marble diagrams into real-world examples.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published