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

Single page with all operators vs. One operator per page #150

Open feloy opened 6 years ago

feloy commented 6 years ago

Hi, I would like to discuss about the fact that all the operators docs reside in a single page. I can see different problems with this single-page design:

Would you be interested that I propose a new design based on one page per operator?

btroncone commented 6 years ago

This is something I went back and forth with when designing this section. In the long term as we fill in the documentation the page will either have to load content incrementally on scroll or we would need to switch to swapping out the operator content as you click through (as you propose). Loading 70+ images + diagrams + multiple JSBin embed's all at once just isn't feasible.

The downside is you lose discovery through simply scrolling, the user would need to click through instead. I'm not sure how important of a use-case that is though.

I say go for it and let's see how it feels in comparison. There shouldn't be much that needs to be done to convert the page. I noticed a couple of UI quirks with the scroll container in the last update, maybe you could take a quick look at that while you are in the area as well?

Thanks for your help!

ladyleet commented 6 years ago

@feloy @btroncone 👍

feloy commented 6 years ago

I've just made a PR for the container scroll bug. I'm working on a version with a single operator per page.

btroncone commented 6 years ago

Thanks, merged! 👍

feloy commented 6 years ago

@btroncone I'm working on 3 different PRs:

ladyleet commented 6 years ago

@feloy love to see that!