timdp / swirly

A marble diagram generator.
https://swirly.dev
MIT License
118 stars 3 forks source link

Need examples? #34

Open carltheperson opened 2 years ago

carltheperson commented 2 years ago

Sorry for making an issue for this. This is not an issue

Swirly is amazing. It is exactly the tool I was looking for.

Context: I have been learning RxJS and to do that I wrote a bunch of notes. These notes are much better with diagrams and your tool makes making these diagrams a breeze. You helped me learn which is an awesome thing to do. Thank you.

Anyway, I now have this repo full of diagrams and it got me thinking: maybe some of them could be useful for you. If you need extra examples and such. Feel free to steal from my notes!

Here is the repository https://github.com/carltheperson/rxjs-notes.

FYI: Swirly was very hard to find for me. It doesn't show up well in Google search results which is a shame. If you ask me, it should be referenced somewhere on rxjs.dev. I had to go digging in the RxJS repo to find it.

timdp commented 2 years ago

Thank you so much! 😍

Discoverability could indeed be improved, both for the examples and for Swirly itself.

For the former, I should really just get started on a proper website, or at least some more Markdown in the repo. I'm lazy like that. The examples that you built look great. I can definitely see myself adopting them (and crediting you, of course). I'll also share your notes with my team.

As for the latter, that's up to the RxJS team. 🙂 A smart guy like you can easily find his way through the codebase but I can think of a few ways to make it easier. The team are still working on using Swirly for more diagrams in the docs though. I do think that should take priority.

timdp commented 2 years ago

As a baby step, I've added a single-page examples.md to the repo. This way, at least you don't have to click through a bunch of files. Plenty of possible improvements though!