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

Wiki Pages for examples #49

Closed
marukami opened this issue Feb 6, 2016 · 2 comments
Closed

Wiki Pages for examples #49

marukami opened this issue Feb 6, 2016 · 2 comments

Comments

@marukami
Copy link
Contributor

marukami commented Feb 6, 2016

Do you think that having github wiki page for each example would help people new to Rx understand the examples better? I'm thinking something like Code Path. Then we could use resource like http://rxmarbles.com/ to help visualize the example.

@kaushikgopal
Copy link
Owner

Hmm... I like the idea of the wiki but do you think it would give any additional value besides the README?

If i remember correctly, github wikis have to be maintained independently and at that point I really don't see the value if it's a more flushed out README.

One of my initial ideas was to change all the existing "log" statements in the examples to a visualization. I almost started a similar RxJs repository to whip up the examples but life got in the way :P.

The other trouble (from my early memories of trying to come up with something like RxMarbles pre rxmarbles.com) was that the boilerplate to set it up was non-trivial. There was enough anciliary code that it actually made the examples harder to understand, which i'm definitely against. The point of the repo was always to make it super simple to just see the code and understand how Rx achieves the examples.

@marukami
Copy link
Contributor Author

I think your right. I will suggest linking to the examples from the README, you already refer to the PseudoCacheMergeFragment without a link.

Thanks for the feedback. I think what I will do is setup another repo similar to how Code Path work and use the examples as resources for tutorials. That way I can also include multiple languages and platforms. especially since I'm working on some C# and F# examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants