juliaanimators / javisnb.jl Goto Github PK

Is your feature request related to a problem? Please explain.

Currently, Javis has Jupyter + Interact utilities inside of the package.
It would be best to move those out to JavisNB.

Describe the solution you'd like

Move the lines starting here: https://github.com/JuliaAnimators/Javis.jl/blob/bc65d7a29fcf80e92b08b2455e699d65b822f718/src/javis_viewer.jl#L241

Pertaining to Jupyter to JavisNB!
Make sure to also migrate the tests as well!

Steps:

• Migrate Jupyter utilities
• Create tests
• Add documentation

Describe alternatives you've considered

N/A

Additional context

Based on a conversation with @gpucce

Is your feature request related to a problem? Please explain.

Currently, Javis has Pluto + Interact utilities inside of the package.
It would be best to move those out to JavisNB.

Describe the solution you'd like

Move the lines starting here: https://github.com/JuliaAnimators/Javis.jl/blob/bc65d7a29fcf80e92b08b2455e699d65b822f718/src/javis_viewer.jl#L241

Pertaining to Pluto to JavisNB!
Make sure to also migrate the tests as well!

Steps:

• Migrate Pluto utilities
• Create tests
• Add documentation

Describe alternatives you've considered

N/A

Additional context

Based on a conversation with @gpucce

Is your feature request related to a problem? Please explain.

Not really a problem so much as a cool piece of inspiration from work done by @leephillips in his great blog on Ptolemy's Universe.
What I think is worth a discussion is about how to maybe define helpful auxiliary tools in JavisNB tailored specifically to notebooks such as Pluto and Jupyter.

Describe the solution you'd like

I really loved the layout Lee made here:

I would love it if we can provide specific sorts of toggles and buttons for JavisNB users to automatically add in their sliders.
@leephillips - in your experience, was there much difficulty with making these sliders and widgets in Pluto?

Describe alternatives you've considered

Letting a user define their own widgets and bindings can be useful, but it may be better to make some convenience notebook widgets available.
I do not know if that would be great - what do you think @gpucce ?

Additional context

N/A

Describe the bug

The gifs in the docs do not seem to be working.

To Reproduce

N/A

Expected Behavior and Actual Behavior

I was expecting the docs and gifs to be tracked by Documenter but nothing seems to get linked properly to display the gifs.

Stacktrace (If Applicable):

N/A

Screenshots

N/A

Additional context

N/A

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers.
Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue.
I'll open a PR within a few hours, please be patient!

@JuliaRegistrator register()

Is your feature request related to a problem? Please explain.

Currently, the CI script in workflows, does not deploy docs yet.
This is not great as we need docs!

Describe the solution you'd like

I would like to have the Documentation up and running with documenter showing how one can interact with notebooks.
I don't think it needs to be too complicated as there may not be too much to show for this package at the moment.
If you need assistance myself or @Wikunia can advise!

Describe alternatives you've considered

Docstrings!

Additional context

Based on conversation with @gpucce several weeks ago.