Hi @zynthianers!
This is a little report about the progresses on the new help system & user guide for Vangelis:
-
Zynthian UI’s help pages have been moved to a new repository: zynthian-help
-
The help pages are now accessible by 3 ways:
- From the zynthian UI, as contextual on-screen help
- V5 => bold-push ALT
- V1-V4 => long-push knob 1 (layer)
- From webconf => Help/Built-in help
- Internet => https://help.zynthian.org
All the 3 show the same contents from the repository zynthian-help. The zynthian-help repository now includes a little server based in python’s tornado that allows to serve the help pages locally. Very useful for editing and testing the changes.
- From the zynthian UI, as contextual on-screen help
-
The web-browser versions (webconf & online) include extra screenshots and videos. I’m thinking of integrating the “zynthian mockup” to allow playing complete workflow captures with all the LEDs, button and knob details.
-
Yes. It would be nice to have an index panel at left
Although there is still a long way to complete all the “holes”, the pieces start to get aligned now.
Documenting zynthian is a huge task, and a difficult one, so … if some of you is interested in helping with this, please, contact me!!
All the best,