search

BelaPlatform / Bela

Bela: core code, IDE and lots of fun!
Other
493 stars 139 forks source link

Write documentation for examples #156

Open giuliomoro opened 8 years ago

giuliomoro commented 8 years ago

like MIDI and oscillator bank

LBDonovan commented 8 years ago

The oscillator bank needs to be turned into a library with an API really, though that's not likely to happen for this milestone

roberthjack commented 8 years ago

Also may be worth considering how the documentation for each example could be viewed in the sidebar alongside the example. Ideally with the Fritzing diagrams for connections too.

Perhaps the 'example docs' button on the top right could be replaced with an additional icon in the sidebar that is 'help', a question mark. When no example is loaded it could display 'Open an example project to view the help file here'.

This also brings up the question of whether it would be worth having a standard format for help files so users could create their own guides to their projects, for example each project could have a separate doxygen file similar to what we have at the bottom of each example plus an image file for the wiring.

giuliomoro commented 6 years ago

MIDI done f8293371fadf207a0fd43060f3332f868244cab6