Knoten dokumentieren

Ihr habt sicherlich schon bemerkt, dass in Node-BLUE die Hilfe zu manchen Knoten nicht vollständig ist und selbst herausfinden müssen, welche Funktionen und Eigenheiten dieser Knoten mit sich bringt. Hat man diese Erfahrung erst einmal gemacht, wäre es natürlich von Vorteil sie zu dokumentieren, damit nicht jeder selbst experimentieren muss. In diesem Sinne möchte ich darauf hinweisen, dass es seit einiger Zeit vereinfacht möglich ist, die Knotenbeschreibung zu erstelllen und sich so ein Stück (mehr) am Projekt Homegear zu beteiligen.

Wie das geht?

Die Knoten liegen in diesem Pfad auf Git. Für den presence-light Knoten hat Sathya beispielhaft eine html erstellt, welche die Knotenbeschreibung enthält. Man braucht also lediglich im entsprechenden Ordner eine html-Datei mit dem Vorbild des presence-light Knoten erzeugen, bzw. bestehende htmls bearbeiten. Nach Prüfung ist der Vorschlag dann fortan Grundlage der Knotenbeschreibung.

3 Likes

Ich haeng mich hier mal ran …

Ich hatte ja vor ein paar Wochen schon mal angefangen alle Nodes zu uebersetzen. Wer noch Nodes ohne und/oder fehlerhafter Uebersetzung findet … gerne korrigieren :wink:

– Micha

2 Likes