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

As a user I want to be able to view docs in hydra. #58

Open
capalmer1013 opened this issue Aug 26, 2019 · 1 comment
Open

As a user I want to be able to view docs in hydra. #58

capalmer1013 opened this issue Aug 26, 2019 · 1 comment

Comments

@capalmer1013
Copy link

It would be very nice to view function docs in a running hydra window like how Sonic-Pi has a documentation viewer built in.

@ssssam
Copy link
Contributor

ssssam commented Dec 9, 2019

I'm sporadically working on this.

My first attempt was https://github.com/ojack/hydra/pull/62 which had the documentation online on a separate page.

Then we scoped out how to make the documentation inline in the hydra editor and I made this list...

  1. Move function documentation from docs/*.md into hydra-synth/src/composable-glsl-functions.js. Write a simple script to generate the docs/funcs.md file from that. We could commit the generated file to Git at this point, so everyone can still read the documentation online. -> https://github.com/ojack/hydra/pull/65

  2. Add jBox jQuery UI library and make the help popup draggable.

  3. Add marked library. Insert the content of the generated funcs.md file in the help dialog.

ssssam referenced this issue in ssssam/hydra Dec 9, 2019
This makes the window more useful for viewing inline documentation,
as planned in https://github.com/ojack/hydra/issues/58.
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