Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(esdoc): add playground environment in ESDoc-generated page #1385

Merged
merged 1 commit into from
Mar 3, 2016

Conversation

staltz
Copy link
Member

@staltz staltz commented Feb 24, 2016

Add Rx.umd.js script to the ESDoc-generated page, so RxJS can be experimented in the DevTools. Also add a welcome message in the console, and a hint text in index.md.

To see this page live, open http://rxjs5-esdoc-rxjs-playground.surge.sh/

screen shot 2016-02-24 at 15 01 17

@kwonoj
Copy link
Member

kwonoj commented Feb 24, 2016

I was thinking about adopt in-frame jsbin like http://xgrommx.github.io/rx-book/content/observable/observable_instance_methods/amb.html in further - would it be considerable? doesn't require to open up console, also supports different env (TypeScript, mostly)

@staltz
Copy link
Member Author

staltz commented Feb 24, 2016

We can have both. Many libraries anyway have the library available in devtools console, so we should do that too for consistency.

About the JSBin, if we do that, we shouldn't do it for each operator, because the page will definitely get heavy with so many iframes.

@kwonoj
Copy link
Member

kwonoj commented Feb 24, 2016

We can have both.

: Yes, totally agree.

, we shouldn't do it for each operator, because the page will definitely get heavy with so many iframes.

: Yes, totally agree (too). I liked idea of embedding jsbin but also not quite much in favor of having it per each operator.

@kwonoj
Copy link
Member

kwonoj commented Mar 1, 2016

Looks good to me.

@benlesh
Copy link
Member

benlesh commented Mar 2, 2016

This looks good. Especially as a first pass. The only thing I can think of is some people might create a Subscription (similar to what's been suggested in console) and not keep a handle to their subscription so they can tear it down. But it's a fine solution until we can get something more robust.

Also I <3 ASCII Art.

@benlesh
Copy link
Member

benlesh commented Mar 2, 2016

Just needs a rebase it looks like.

@staltz
Copy link
Member Author

staltz commented Mar 2, 2016

I'll rebase it tomorrow, and I can also change that suggested example to have var subscription = prepended. :)

@staltz
Copy link
Member Author

staltz commented Mar 3, 2016

Rebested.

Add Rx.umd.js script to the ESDoc-generated page, so RxJS can be experimented in the DevTools. Also
add a welcome message in the console, and a hint text in index.md.
@kwonoj kwonoj merged commit 98e183d into ReactiveX:master Mar 3, 2016
@kwonoj
Copy link
Member

kwonoj commented Mar 3, 2016

Merged with 98e183d, thanks @staltz .

Re_best_ed.

: Yup I agree, this PR's best thing to docs. 😎

@staltz staltz deleted the esdoc-rxjs-playground branch March 4, 2016 08:13
@lock
Copy link

lock bot commented Jun 7, 2018

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Jun 7, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants