rxjs-docs icon indicating copy to clipboard operation
rxjs-docs copied to clipboard

Published 20 hours ago • verified publisher icon ReactiveX

Provide or update website w/ documentation that is current for what is currently documented.

Open takamori opened this issue 7 years ago • 5 comments

The website is out of date compared to the checked-in code. Example: Observable.subscribe isn't documented yet, even tho there is some jsdoc in the code if one digs through enough.

Creating a new issue for this since we were asked to do so in https://github.com/ReactiveX/rxjs/issues/2656#issuecomment-345958269

takamori avatar Nov 22 '17 15:11 takamori

@takamori thank you for this! we will be discussing this.

ladyleet avatar Nov 26 '17 15:11 ladyleet

any updates?

takamori avatar Dec 11 '17 15:12 takamori

I am working on generating docs from jsdoc and type and translations

valorkin avatar Dec 12 '17 07:12 valorkin

Is there a timeline for getting http://reactivex.io/rxjs updated? Is there anything a RxJS noob like myself could help with to move this along?

I can tell you as a new RxJS user it's extremely confusing, and ultimately frustrating, when the published documentation doesn't include core methods that are referenced in numerous tutorials and code samples.

scottescue avatar Jan 24 '18 20:01 scottescue

@scottescue yep we are working on it! you can go ahead and check out the issues and see if there is anything you can contribute too! happy to help

ladyleet avatar Jan 24 '18 20:01 ladyleet