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

Need examples? #34

Open
carltheperson opened this issue Jun 20, 2022 · 2 comments
Open

Need examples? #34

carltheperson opened this issue Jun 20, 2022 · 2 comments

Comments

@carltheperson
Copy link

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
Copy link
Owner

timdp commented Jun 20, 2022

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
Copy link
Owner

timdp commented Jul 3, 2022

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!

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