search

hydra-synth / hydra

Livecoding networked visuals in the browser
https://hydra.ojack.xyz
GNU Affero General Public License v3.0
2.18k stars 267 forks source link

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

Open capalmer1013 opened 5 years ago

capalmer1013 commented 5 years ago

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 commented 4 years ago

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.