Hauptmenü

Hinweis CommandRef

Begonnen von Guybrush, 28 Mai 2020, 14:17:31

Vorheriges Thema - Nächstes Thema

Guybrush

Ich würde gerne anregen, dass man auf der Startseite von FHEM nach Erstinstallation einen gut sichtbaren Hinweis zur Dokumentation einbaut. Ich nutze FHEM noch nicht so lang und habe nicht gesehen, dass nur die CommandRef Anspruch auf Aktualität hat das Wiki (was sehr gut ist) eben nicht. Dadurch bedingt hab ich dann für das Erstsetups auch auf externe Seiten zurückgegriffen, bei denen dann dummerweise unvorteilhafte Abweichungen bestanden. Insofern könnte das neuen Nutzern ggf. helfen meinen Fehler zu vermeiden.

rudolfkoenig

Ein direkten Hinweis auf Commandref gibt es jetzt schon, das Wiki ist nur indirekt ueber "Remote Doc" zu erreichen.
Ich habe nichts gegen einen Umbau, aber ich wuesste gerne genau, was ich aendern soll.

Beta-User

Ich _glaube_, dass es so gemeint ist, dass man zusätzlich zu dem Hinweis, dass man allowed setzen soll, beim ersten Start (oder bis man es ausschaltet) sowas wie einen Hinweis erhalten sollte, dass die aktuelle Doku unter "commandref" zu finden ist (siehe auch den Anlaß des Posts hier: https://forum.fhem.de/index.php/topic,111567.msg1058470.html#msg1058470).

Grundsätzlich fände ich sowas wie eine "erste Benutzerführung" ja auch wünschenswert (ggf. über ein "firstrun-global-Attribut" (oder einen speziellen Command am Ende der cfg? =>attrTemplate?) umsetzbar), aber irgendwie wäre mir der Hinweis auf die Doku zu wenig. Aktuell habe ich aber auch noch keine wirkliche Idee, wie sowas konkret aussehen könnte.

Vielleicht sollte man den Link auf der linken Seite umbenennen? "commandref" ist jetzt nicht eine Begrifflichkeit, hinter der nicht nur ich nicht unbedingt eine umfassende Hilfe "für jede Lebenslage" vermuten würden. Ist aber eben eingeführt (und an sich auch ok). Schnellschüsse: Docu/Doku.

Alternativ könnten es auch Links sein, neben dem (fetten!) Link auf die commandref (am besten: modular, das ist m.E. besser gegliedert):
https://wiki.fhem.de/wiki/Dokumentationsstruktur/en
https://wiki.fhem.de/wiki/Dokumentationsstruktur

@Guybrush: Du darfst dich gerne einbringen, wie man Anfänger leichter "auf's Pferd bringt", siehe dazu auch meinen [WIP]-Artikel im Wiki-Bereich (ich komme nur grade nicht so voran, wie ich mir vorgenommen hatte).
Server: HP-elitedesk@Debian 12, aktuelles FHEM@ConfigDB | CUL_HM (VCCU) | MQTT2: ZigBee2mqtt, MiLight@ESP-GW, BT@OpenMQTTGw | ZWave | SIGNALduino | MapleCUN | RHASSPY
svn: u.a Weekday-&RandomTimer, Twilight,  div. attrTemplate-files, MySensors