Rxjs: RxJS v6 docs are in repo but not released?

Created on 20 May 2018  路  5Comments  路  Source: ReactiveX/rxjs

I was just about to create a PR that updates the _Installation_ page at http://reactivex.io/rxjs/manual/installation.html, which is still describing RxJS 5, only to find out that it has been updated already 2 months ago in GitHub!

Why is it that these and all other v6 changes in the doc/ folder have not been released to the http://reactivex.io/rxjs site? Right now, the published docs are really misleading.

docs

All 5 comments

The docs are in flux right now. We have a brand new documentation site, and we're in the process of getting it published. Sorry for the confusion.

Okay, so for now, I have http://reactivex.io/rxjs redirecting to the newer docs (with an HTML redirect unfortunately, until we have the new domain setup)

Note that the OP was concerned about instructions in the installation page and the new docs site also have the same outdated instructions in the installation page: https://beta-rxjsdocs.firebaseapp.com/guide/installation

Another concern is: how does one access the old site, now? In case they want, e.g., to read the long-form tutorial or use the operator selection widget.

As @staltz mentioned, the new site seems to have the same outdated state of the docs as the old one when it comes to the guides. Perhaps just redeploy the old ESDoc-based page so that the guides are up-to-date?

By the way, is there a particular reason that there is a new custom-written docs page in the works? Are there any limitations of ESDoc that caused you to make that decision?

The new documentation offers additional opportunities for accessibility for example. Also the old docs were kinda complicated to edit. The new ones should be easier to understand

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Agraphie picture Agraphie  路  3Comments

shenlin192 picture shenlin192  路  3Comments

benlesh picture benlesh  路  3Comments

cartant picture cartant  路  3Comments

OliverJAsh picture OliverJAsh  路  3Comments