Neue Dokumentation für die CometVisu

[peuter]

Falls es noch nicht jeder mitbekommen hat: Die CometVisu hat eine neue Dokumentation bekommen vorerst noch unter folgenden Links zu erreichen:

Deutsches Handbuch:
http://test.cometvisu.org/CometVisu/de/latest/manual/

Englisches Handbuch:
http://test.cometvisu.org/CometVisu/en/latest/manual/

Source-Code Dokumentation:
http://test.cometvisu.org/CometVisu/en/latest/api/

Diese sollten später mal das aktuelle Wiki auf www.cometvisu.org ersetzten (und dann wird in den Links oben das 'test' durch 'www' ersetzt).

Ein paar Worte zum Stand der Dinge:
Das deutsche Handbuch ist momentan am umfangreichsten, die alten Inhalte aus dem Wiki wurden nach bestem Wissen und Gewissen übernommen und teilweise ergänzt. Dennoch gibt es noch viele Lücken die es zu schließen gilt, dazu gibt es eine extra TODO-Seite:
http://test.cometvisu.org/CometVisu/...lab/todos.html

Das englische Handbuch enthält im Wesentlichen nur die Inhalte, die auch in der Source-Code Doku enthalten sind, darüber hinaus fehlt noch alles andere.
Und die Source-Code Dokumentation ist ebenfalls nicht vollständig.

Es gibt also noch viel zu tun und Hilfe ist mehr als willkommen! Wer etwas beitragen möchte, einfach hier im Thread melden.
Neben den vielen Vorteilen der neuen Doku, auf die ich im Detail hier jetzt garnicht eingehen möchte, weil das den Rahmen sprengen würde gibt es einen gravierenden Nachteil: Wer daran mitarbeiten möchte muss sich leider mit Git (https://de.wikipedia.org/wiki/Git) rumschlagen. Die Einsteigshürde für die Doku-Schreiber ist also höher als früher, aber dafür hat man deutlich mehr Möglichkeiten (z.B. automatische Screenshots von Beispiel-Configs in der Doku, um nur eine zu nennen).

Wie schon gesagt, jeder Betrag zu Doku ist herzlich willkommen. Und wenn sich jemand nun gar nicht mit Git anfreunden kann, kann Beiträge zu Doku einfach hier oder in einen neuen Thread schreiben.

[SirTobiIV]

Hi

ich wollte mich nur kurz zurückmelden. Gab in den letzten Wochen/Monaten viel zu tun und zu bemustern. Bis ins neue Jahr darf nun der Estrich trocknen, sodass ich wieder etwas Zeit für andere Dinge haben werde.
Nachdem ich ja angfefangen hatte die Attribute einiger Widgest mit Beschreibungstexten zu versehen, werde ich sicher über die Weihnachtsferien Zeit haben etwas an der Cometvisu und auch gerne der Doku dazu zu arbeiten.
Wie ist denn der aktuelle Stand bzw. wo liegen die Prios?

1. Widget-Attributebeschreibungen vervollständigen?
2. Widgets dokumentieren?
3. Das ganze ins Englische übersetzen?

[peuter]

Das freut mich zu hören. Die Prios liegen eigentlich genau so wie Du sie schon aufgeführt hast. Ich würde lediglich zwischen Punkt 2 und 3 noch das Abarbeiten der TODOs in der Doku einfügen ( siehe: http://test.cometvisu.org/CometVisu/...lab/todos.html, die Reihenfolge dort ist beliebig, muss also nicht von oben nach unten abgearbeitet werden, sondern man kann sich was rauspicken).

Die englische Dokumentation würde ich erst angehen, wenn die deutsche weitestgehend vollständig ist. Bis dahin könnte allerdings die Dokumentation der Widgets im Source-Code vervollständigt werden, denn diese dient wiederum als Basis für die englische Doku (man muss das also nicht an zwei Stellen pflegen sondern Dokumentiert im Sourcecode und da wird das automatisch für die englische Doku ausgelesen).