search

ReactiveX / rxjs-docs

The home for new work on the new RxJS docs (RxJS v 5 and up). New to this space? Say hi here: https://github.com/ReactiveX/rxjs-docs/issues/24. Want to find out what's up? We're chatting here. https://github.com/ReactiveX/rxjs-docs/issues/4
Apache License 2.0
160 stars 62 forks source link

Versioning of documentation #162

Open ashwin-sureshkumar opened 6 years ago

ashwin-sureshkumar commented 6 years ago

Just kicking off a discussion regarding versioning documentation for different releases of RxJS.

Similar to angular.io, vuejs.org ..

ashwin-sureshkumar commented 6 years ago

cc @btroncone @ladyleet @sumitarora @kwonoj

ladyleet commented 6 years ago

@benlesh @kwonoj just curious if you guys think we need this? i mean... will the versions change that much? also, i love ember's versioning of their docs - i think it's quite impressive how they handle it. we should check that out too!

mustafamg commented 6 years ago

@ashwin-sureshkumar , good point. @ladyleet, good suggestion. I go for it. ember Js versioning is more convenient with API versioning. When you change the version, it brings you the old version of the same command or keeps the current if they are the same. if the command is no longer exists, it gives you a not found page.

For Angular.io and vue js, they both redirects you to a completely new website. The reader loses the focus and needs to research for the command he is interested in.

That is why I go for ember js as it is IMHO more convenient with RxJs API documentation style.

ladyleet commented 6 years ago

👍

niklas-wortmann commented 6 years ago

I think versioning is quite important for such a huge library like rxjs. Ofc there shouldn't be that much different in each version. But you could emphazise changes/improvements for the selected version for example. Maybe it would also fit to make an amount of version selectable, for example just orientate on major release or something like that. Furthermore I think this would also offer the oppertunity to promote breaking changes at a very central point (hopefully there won't be some)

benlesh commented 6 years ago

FYI: I think version is very important, especially going forward.