Commented examples / Basic Docs

[Robert-M-Muench]

I think what you have created is pretty cool and way under-recognized in the D community.

The code base is not easy to understand (at least not for a casual D user) and the examples are not self-explanatory.

How about creating a minimal documentation, comment the examples etc.? I'm open to help but need some guidance too first.

[lempiji]

Thank you:smiley:
I write it as a hobby, so I think that the guidelines and documentation are missing.
Let's start with CONTRIBUTING.md.

I am unfamiliar with English, so I hope for pull request and advices!

[Robert-M-Muench]

I think RX is already in a state where it deserves more attention and hopefully some others jump-on.

What's your native language?

[Robert-M-Muench]

Since there is not a lot of action at the moment I wouldn't start with CONTRIBUTING.md or if, just put in: Submit a PR.

I think we can start by extending the start-page a bit and later on, maybe a Wiki for best-practices etc. but let's keep things simple.

[lempiji]

Oh, I intended to "I'm going to write the CONTRIBUTING.md".
I am an Japanese 🇯🇵 and I using Google Translate.

Also, I got an opinion on Twitter that it is good to have docs if I make a tutorial.
I am looking for something good way. Please let me know if you know.

[Robert-M-Muench]

Thanks for continuing to maintain rx. It's really great stuff.

I still think more docs / simpler examples like overview would be great. Especially how the concepts behind the reactive idea are supposed to be used with D/rx.

[Robert-M-Muench]

Trying to tweak/use the source code is really hard. It's quite complex with no comments. Could you add more comments and a description of the overall design idea? One needs to understand your concepts to understand the code.

How is threading used? How are things related? Some graphics would help too.