How to add a new language of docs, such as Chinese? Just put the new markdown files to subfolders, such as /cn?

I think reactivex.io site deserves the @headinthebox treatment with a few sections walking through the theory and computer science of Reactive Extensions. What do you think @headinthebox ?

Thoughts on topics:

• the duality explanation ... Iterable vs Observable
• push vs pull
• how does Rx differ from event driven and callbacks?
• comparisons against promises, futures, channels, CSP
• async vs concurrent vs parallel execution
• where it fits into lambda calculus, pi calculus, join calculus, actors approaches to concurrency models
• reactive pull and flow control

I would like for www.reactivex.io to be the definitive source of truth for these topics in relation to Rx rather than blogs, whitepapers, comments and wikis all over the net.

See ReactiveX/RxJava#2839 for a discussion of this and an example of trouble.

https://github.com/neuecc/UniRx

See http://reactivex.io/documentation/operators/to.html.

The documentation got off to a good start with implementation-specific information for Java, Groovy, and JavaScript, but the equivalent RxKotlin sections are mostly empty.

Pages that are in particular need of help here are:

• The various operator pages linked to from http://reactivex.io/documentation/operators.html
• http://reactivex.io/documentation/subject.html
• http://reactivex.io/documentation/scheduler.html

The documentation got off to a good start with implementation-specific information for Java, Groovy, and JavaScript, but the equivalent RxScala sections are mostly empty.

Pages that are in particular need of help here are:

• The various operator pages linked to from http://reactivex.io/documentation/operators.html
• http://reactivex.io/documentation/subject.html
• http://reactivex.io/documentation/scheduler.html

The documentation got off to a good start with implementation-specific information for Java, Groovy, and JavaScript, but the equivalent RX.rb sections are mostly empty.

Pages that are in particular need of help here are:

• The various operator pages linked to from http://reactivex.io/documentation/operators.html
• http://reactivex.io/documentation/subject.html
• http://reactivex.io/documentation/scheduler.html

On the frontpage, I'm planning to include a section "Who uses Rx" listing a few companies that use Rx in a significant way or as a core technology. My memory is very bad at the moment and honestly I can just think of Netflix and Couchbase.

So, could you guys list a few more so I can fill this list?

UPDATE:

If you wish to have your companies' logo and link on the frontpage, just provide a png image of size approx. 500x200 (or better), with white or transparent background, and a link to the page. We can include logos as much as there is incoming, but at some amount (maybe 12?), we should reconsider which ones are stronger for social proof.

Logos will be sorted by decreasing Alexa ranking (global), and with a max of 12 logos on the frontpage.
Current sorting as of 19 September 2014:

1. Microsoft (42)
2. Netflix (81)
3. GitHub (133)
4. SoundCloud (180)
5. Trello (531)
6. Treehouse (2,224)
7. SeatGeek (14,258)
8. ooVoo (24,278)
9. Couchbase (49,285)
10. Futurice (385,110)
11. Welbe (1,573,204)

Footer should always be at the bottom, even on very large screen sizes.
Use http://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/

The GitHub API rate limit might become a problem for the dynamic code examples (loaded client-side).
The API allows only 60 requests per hour for unregistered users...
Registered users are permitted to do 5000 requests per hour, but that would require user authentication (Basic/OAuth).

The documentation got off to a good start with implementation-specific information for Java, Groovy, and JavaScript, but the equivalent RxPY sections are mostly empty.

Pages that are in particular need of help here are:

• The various operator pages linked to from http://reactivex.io/documentation/operators.html
• http://reactivex.io/documentation/subject.html
• http://reactivex.io/documentation/scheduler.html

Once the build infrastructure for RxScala works, we can start moving the examples in RxScalaDemo to src/examples/reactivex/getting-started and include them in the website.

I found it in the JS folder, and it's huge (25M). Why do we need it? I tried looking for its usage, but it's not clear why it is necessary.

@GeorgiKhomeriki ?

(This was discussed in Issue #20 by @headinthebox, @GeorgiKhomeriki, @samuelgruetter, @benjchristensen, @staltz & @DavidMGross but deserves a stand-alone issue.)

The documentation is full of code samples. To ensure that these are (and remain) accurate, they should be tested and these tests should be re-run whenever changes are made to the samples, the ReactiveX implementation they are written against, or relevant parts of the language/OS they run within.

How to do this well is a bit of a puzzle. Some of the issues/ideas:

• we could have the code samples in the test suites for the various ReactiveX implementations, and then pull the code directly from those samples to insert in the appropriate places in the web pages; single-sourcing the samples in this way would ensure that they don't get out-of-sync.
  • however: many code samples are just sections of code that aren't executable stand-alone. To make them testable would mean adding a lot of cruft around them that would make for inappropriate noise in the documentation context. We'd need to have some way (or perhaps a variety of language-specific ways) of isolating the part of the code that is meant for documentation from the part that's necessary to make it testable.
  • we'd need a strategy for pulling the code samples into the documentation
    • if we do this dynamically when the page is requested, this puts extra load on the server
    • if we periodically build static pages via a make-like process, we need to trigger the make appropriately
• Many of the samples in the documentation also show the expected output; is there a way to keep that automatically in sync with the tests run on the samples, or, in order to make that synchronicity testable would we have to change these so instead of the expected output we show the tests the code is expected to pass (a bit like the Hystrix docs do here: https://github.com/Netflix/Hystrix/wiki/How-To-Use#Synchronous-Execution) -- something I think would make for more awkward and less clear documentation in our case, but maybe it's worth that cost.

Thoughts?

Reactive Extensions for Python (RxPY) at http://reactivex.io/languages.html should link to https://github.com/dbrattli/RxPY and not https://github.com/Reactive-Extensions/RxPy.

Both https://github.com/Reactive-Extensions/RxPy and https://rxpy.codeplex.com/ are outdated clones that haven't been updated for over a year. I have given up trying to keep all repos in sync, and will only continue development on my private repo.

I don't have sufficient permissions to do this, I don't think. @benjchristensen maybe?

We do our site development in "develop" and then periodically generate the site locally using rake before checking it in to the "master" branch -- that is to say, nobody should be checking in incremental changes to "master."

New contributors are confused by this and often try to alter "master" directly as it's the default branch.

Right now the documentation is too implementation specific.

For example, this page assumes RxJava: http://reactivex.io/documentation.html ... particularly in how it puts binaries as the first thing being shown.

Right from the start this page needs to include at least RxJS and RxJava.

I suggest we start with just a simple page with links to existing RxJS, RxJava and soon to arrive documentation from RxScala, RxAndroid etc.

Then we can start to shape it into this new model

I'd like to use this site as the landing page now even though we don't have the docs in place.

In IE11, only a menu bar is shown, but no content. This also seems to be the case in IE9 and 10.

Developer tools show the following javascript error:

"Unable to get property 'language' of undefined or null reference."

Right now it looks like the docs are in /observables/. It took me a bit to find it. Should we have all docs under a folder such as /docs/ or /documentation/?

At least on IE 11 the site's UI looks everything other than "reactive". Menu items are hidden by the logo, don't think it is a desired effect? ;-)

ReactiveX/RxJava#2557 concerns the javadocs in particular, but something similar probably belongs on our operator-specific documentation pages.

The documentation got off to a good start with implementation-specific information for Java, Groovy, and JavaScript, but the equivalent RxCPP sections are mostly empty.

Pages that are in particular need of help here are:

• The various operator pages linked to from http://reactivex.io/documentation/operators.html
• http://reactivex.io/documentation/subject.html
• http://reactivex.io/documentation/scheduler.html

We'll want to establish the mechanisms for collaboration. For example, Google Groups, HipChat, IRC, Twitter, etc.

This Google Group exists already: https://groups.google.com/forum/#!forum/rxjava

Twitter already has RxJava and ReactiveX

Issue for tracking discussions about what topics we should have tutorials for. This is slightly different than the normal docs which often are focusing on operators and creation/consumption. This is more for the end-to-end docs, how to solve use cases and problems.

As we agree upon ideas new issues for individual work can be created to track execution.

The reactivex.io home page fills the entire browser window with the header.

Based on Paul Taylor's decision trees for RxJS operators:
https://github.com/trxcllnt/RxJS/blob/master/doc/static-operators.md
https://github.com/trxcllnt/RxJS/blob/master/doc/instance-operators.md

Here's a version for ReactiveX in general, but most of the links don't work yet:
http://reactivex.io/documentation/Operators/operators.html

I'm not sure if we can leverage something in the CSS / site generation we're already working with or if we'd need to pull in some additional CSS/JS to make this work.

Most of what is in the operator pages, including the sample code sections, is in HTML rather than markdown, although those pages go through the markdown->html generator like the rest of them, so maybe we could leverage that.

The code sample sections are currently marked with <div class="codelanguageName"> in anticipation of being able to accomplish this at some point.

(Copied over from ReactiveX/RxJava#2955)

JensRantil:

Source: http://reactivex.io/documentation/scheduler.html

• Neither of the schedulers has a working link to corresponding JavaDoc.
• Schedulers#computation documentation doesn't state how many threads it runs. Whether it runs async or really anything. I had to dig into source code and finally ended up on https://github.com/ReactiveX/RxJava/pull/2580/files which states it defaults to number of processors threads.
• Schedulers#io is missing the same documentation; how many threads? Does it grow infinitely?

I tested the new embedded RxMarbles diagrams in Chrome, Firefox, and Safari 7.1.3, and while they seem to work in the first two, they don't render at all in Safari.

When I view-source, the RxMarbles line is <rx-marbles key="foo"></rx-marbles>... that is, unchanged from the static source.

There's a javascript error that only seems to show up in Safari ("TypeError: Attempted to assign to readonly property." at patches-mdv.js, line 57)... not sure if that would have anything to do with it (that error also turns up on pages that don't have embedded RxMarbles diagrams). I don't see any other javascript errors or warnings.

I saw this from Ben's recently published presentation:

There are a couple of things broken here: jumbotron arrow position, jumbotron height, and diagram arrow heads. Which browser were you using here, @benjchristensen ?

(I intend to fix these once I know)

André Staltz: "Each of these that have width="640" should be fixed to width="100%" so that the image is also responsive (specially for mobile)."

On phones, the jumbotron background image should be statically positioned to perform better. Its height also needs to be improved.

This is how the footer looks on iPhone.

I can fix this issue.

One basic question: where should the interactive marble diagrams be placed on the website? Under a dedicated section? One interactive diagram under each documented operator? Somewhere else?

That's important to know because it affects how I should adapt http://staltz.github.io/rxmarbles to this website.

Can I take the initiative to improve the looks of the site? I'll do this in a separate branch, and we can iterate over the pull requests I send, so that you guys can give your opinions before merging the changes.

Things I'd like to improve:

• Typography. The line width is currently too long, which makes text a bit less readable. Line width should be about 2 * abcd...xyz (the alphabet). Also making the font a bit bigger helps. These changes would bring the site closer to what typical Github markdown docs look like with regard to typography.
• Better fonts. The title "ReactiveX" on the hero could get a nicer font which is not the same as the content font.
• Favicon: matching the purple/pink logo.
• Other tweaks.

Is this ok?

We need to get setup with Sonatype so we can publish projects with the orgId io.reactivex.

NOTE: This is specific to Java based projects.

About a year ago, I made a small website for RxScala (http://rxscala.github.io/). Now that there is one central http://reactivex.io/, it would be good to move the contents of http://rxscala.github.io/ to http://reactivex.io/.

Currently, http://rxscala.github.io/ contains the following:

• Some general info and links: http://rxscala.github.io/
• The scaladoc: http://rxscala.github.io/scaladoc/index.html#rx.lang.scala.Observable
• Comparison table which gives the Scala equivalent for each method of the Java Observable: http://rxscala.github.io/comparison.html

The markdown source for the general info is page is here.

The scaladoc can be obtained by running ./gradlew scaladoc in the RxJava repository, or by copying this folder.

The comparison table is auto-generated by the printMarkdownCorrespondenceTable method in CompletenessTest.scala, and the generated markdown of the most recent version (0.20.4) is here.

I'm not a web designer at all, and I'm opening this issue hoping that a web wizard (such as @GeorgiKhomeriki or @staltz) will take care of this ;-)

Of course I'm available for answering any RxScala specific questions, or questions on the http://rxscala.github.io/ website.

The documentation got off to a good start with implementation-specific information for Java, Groovy, and JavaScript, but the equivalent RxClojure sections are mostly empty.

Pages that are in particular need of help here are:

• The various operator pages linked to from http://reactivex.io/documentation/operators.html
• http://reactivex.io/documentation/subject.html
• http://reactivex.io/documentation/scheduler.html

The documentation got off to a good start with implementation-specific information for Java, Groovy, and JavaScript, but the equivalent Rx.NET sections are mostly empty.

Pages that are in particular need of help here are:

• The various operator pages linked to from http://reactivex.io/documentation/operators.html
• http://reactivex.io/documentation/subject.html
• http://reactivex.io/documentation/scheduler.html

Both RxJS and Rx .NET implement DelaySubscription:

• Rx.Observable.prototype.delaySubscription
• Observable.DelaySubscription(TimeSpan dueTime, IScheduler scheduler)
• Observable.DelaySubscription(DateTimeOffset dueTime, IScheduler scheduler)

The dropdown menus are not behaving correctly in IE.

I'm noticing a "Popover requires tooltip.js" error in the javascript console window, from bootstrap.min.js.

See ReactiveX/RxJava#2959

This issue is intended to kickoff the discussion of what the www.reactivex.io website should include and get the work started on it.

• Intro, what it is, what it solves, why it exists.
  • how to get started quickly
  • dependency management for each language and hello world
  • links to latest releases for each language
• Documentation
  • common across all languages
    • existing documentation for RxJava (https://github.com/Netflix/RxJava/wiki) and RxJS (https://github.com/Reactive-Extensions/RxJS/tree/master/doc) can hopefully be used as a starting point and come together somehow
    • we want a mechanism for docs to be written and maintained in Github and show up nicely formatted on the site (does not need to keep leveraging the wiki though, can be Markdown or other formatted files in the site repo)
  • language specific details
  • each operator can have the common marble diagrams, then per-language examples, idioms, synonyms, etc
• Languages
  • list of languages with news, release notes, documentation etc specific to each implementation
• Related Projects
  • other projects that are not Rx implementations, but related to it … projects that use or leverage Rx
• Media
  • presentations, talks, conferences etc
• Community
  • google groups, twitter etc
• Github
  • github.com/ReactiveX for all code, issues, etc for each language
• Releases and Binaries
  • Apache (eventually)

Here are example sites:

http://vertx.io (particular see how code examples are done for each language)
http://netty.io
http://www.ratpack.io
http://akka.io
http://emberjs.com
http://angularjs.org
http://spark.apache.org

The site displays but pages don't scroll when loaded on iPhone and iPad using safari.

As soon as #42 and #43 are fixed, we should add forwarders from the old RxScala website which redirect page visitors to http://reactivex.io/rxscala/.

When clicking around documentation the pages load slowly. They first open to a blank page, then a second later the content appears.

It feels like it is loading javascript, processing it, then downloading content.

The assumption is that our pages are simple, pre-generated HTML so we should be able to hit static HTML and only have javascript involved when doing the embedded code snippets.

Let's rewrite the Rx Design Guidelines as part of the reactivex.io site.

In firefox version 30.0 (tested on OS X 10.8) the code sample tabs are not working correctly.
The tabs are created using Polymer custom tags (w/ paper tabs).
This issue can be observed on: http://reactivex.io/embed-test

The RxJava/RxScala comparison table should have solid borders, and use the full width of the page, because the signatures tend to be very long.

Something similar to the template used on the old page might be used: https://github.com/RxScala/RxScala.github.io/blob/master/_layouts/comparison.html

So that it looks more like this: http://rxscala.github.io/comparison.html

We need to get setup with CloudBees, Travis (https://travis-ci.org) or something like that for automated building.

We also need a mechanism for releases (today done by Netflix infrastructure for RxJava).

I don't know what other languages need so keeping this focused to Java.