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

Feature request: Video tutorial #239

Open
Datseris opened this issue Jul 13, 2018 · 4 comments
Open

Feature request: Video tutorial #239

Datseris opened this issue Jul 13, 2018 · 4 comments

Comments

@Datseris
Copy link

I'd like to learn this package, but to my surprise the entire documentation (currently) doesn't any figures and any videos. For me it is not totally straight forward to read the docstring and imagine how it would look...

Given that this package is creating visual things through interaction, a video tutorial that demonstrates basic usage would be super duper awesome!

@piever
Copy link
Collaborator

piever commented Jul 13, 2018

A video tutorial is an interesting idea. Before that happens, I'd recommend checking out the example notebooks in the doc folder. Especially tutorial.ipynb should give you a good overview (the online version is displayed without output but you could simply run it locally). I was also thinking of making the tutorial executable online via Binder but I couldn't get it to work the last time I tried, will try again as soon as I have some time.

@Datseris
Copy link
Author

Keep in mind that there is no link on the documentation page that links back to the example notebooks in the doc folder. A link should be there (as I was not aware that a notebook existed).

Glad to see you interested in the video tutorial idea, I think it can be very helpful!

@piever
Copy link
Collaborator

piever commented Jul 13, 2018

That's embarrassing, I was sure it had a link but somehow it got lost when copying things from InteractBase.

@piever
Copy link
Collaborator

piever commented Jul 14, 2018

Added link: if after having gone through the tutorial you have ideas on what kind of material would have helped you to learn faster / more efficiently, feel free to make a docs PR (it's always hard to write docs after using something for too long).

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