Q Light Controller+

Massimo and others:

Google is starting Season of docs, similar to Summer of Code, this time focused on documentation.
It may be a opportunity to have someone improve QLC+ documentation (might be in time for QLC+5,
since the actual writing starts in September!).

At least two administrators and two mentors are needed (may two people altogether).

Details: https://developers.google.com/season-of-docs/
Registration deadline: 23. April.

Some ideas were mentioned in http://qlcplus.org/forum/viewtopic.php?f=12&t=11938

My ideas:

Phase I
- convert the current documentation to asciidoctor
- create asciidoctor HTML template for online docs
- create asciidoctor-pdf template for offline/printable PDF
- use asciidoctor to create mobile versions (epub et al)
- it may be possible to generate QML to include directly in the app...

Phase II
- reorganize the documentation so it looks like an actual book

Phase III
- update the documentation for QLC+5
- ideally the docs can be #ifdef'ed for either QLC+4 or QLC+5

Phase IV
- go through forums and collect difficult areas, enhance docs for that areas

I may provide help in Phase I with setting up AsciiDoctor (needs ruby or java+jruby)
and I think many of people here can chime in for Phase IV...

Just a thought.

Jano

James Eliott has code to generate documentation site from Asciidoctor:
https://github.com/Deep-Symmetry/beat-l ... master/doc
He writes that he also generates embedded documentation for his program this way.