Dokumentation

Adapter-Dokumentation

Jeder Adapter sollte seine eigene Dokumentation im entsprechenden Repository (meistens GitHub) ablegen. So werden Dokumentationen auch automatisch versioniert. Hier gibt es zwei Möglichkeiten:

  1. Eine README.md im Projekt-Root

  2. Eine definierte Liste von Dokumentations-Dateien, welche über die io-package.json gepflegt wird (siehe common.docs).

Es werden regelmäßig die Inhalte von allen Repositories abgeholt und in das Repository ioBroker.docs kopiert. Dadurch sind alle Adapter-Dokumentationen auch auf der offiziellen Webseite von ioBroker abrufbar.

Öffnet man nun z.B. im Admin-Adapter eine Adapter-Dokumentation, wird diese ebenfalls auf https://www.iobroker.net/<lang>/adapterref/iobroker.<adapter>/README.md geöffnet.