Skip to content

docu: unify filename/folder usage, focus on current version#767

Merged
Morg42 merged 3 commits intosmarthomeNG:developfrom
Morg42:doc
Mar 29, 2026
Merged

docu: unify filename/folder usage, focus on current version#767
Morg42 merged 3 commits intosmarthomeNG:developfrom
Morg42:doc

Conversation

@Morg42
Copy link
Copy Markdown
Member

@Morg42 Morg42 commented Mar 9, 2026

Wie vorgeschlagen habe ich

  • Ordner-/Dateinamen vereinheitlicht (z.B. etc/plugin.yaml statt ../etc/plugin.yaml, Konfig in etc, Schreibweise in doppelte Backticks)
  • Verweise auf frühere Konfigurationsmöglichkeiten und Hinweise, seit wann etwas unterstützt wird, entfernt.

- den Metadaten: module.yaml

Beide Dateien lliegen in einem Unterordnet des Ordners ``../modules`` und dieser Unterordnet trägt den Namen des
Beide Dateien lliegen in einem Unterordnet des Ordners ``modules`` und dieser Unterordnet trägt den Namen des
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

liegen

Der Core von SmartHomeNG besteht aus einem Haupt-Objekt welches in ``bin/smarthome.py`` definiert ist und einer
Reihe von Programm Modulen, die exklusiv für die Nutzung durch den Core Hilfs-Objekte implementieren.
Die Programm Module sind in dem Ordner ``../lib`` abgelegt und im Unterpunkt **Programm Modulen** beschrieben.
Die Programm Module sind in dem Ordner ``lib`` abgelegt und im Unterpunkt **Programm Modulen** beschrieben.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Module


Diese Anleitung beschreibt eine komplette Installation von **SmartHomeNG v1.10** auf
Diese Anleitung beschreibt eine komplette Installation von **SmartHomeNG v1.12** auf
einem Linuxsystem mit Debian 12 (bookworm).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neue Installationen sollte nur noch mit Trixie erfolgen denke ich

@@ -337,7 +337,7 @@ Konvertierung von \*.conf-Dateien

Möchte man vom alten ``*.conf`` Format der Konfigurationsdateien
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hatten wir *.conf nicht rausgeworfen? Dann kann jetzt nur noch der conf_to_yaml_converter genutzt werden

finden Sie :doc:`hier </konfiguration/konfigurationsdateien/konfigdateien>` unter
**Aufbau der Konfigurationsdateien**.
Informationen zum :doc:`Dateiformat </konfiguration/konfigurationsdateien/konfigdateien>`
finden Sie :doc:`hier </konfiguration/konfigurationsdateien/konfigdateien>` unter
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"finden sich unter" das Sie sollten wir nicht nutzen wenn es geht.

bevorzugende Methode ist.

Dazu kann das Objekt **logic** genutzt werden, welches SmartHomeNG zur Verfüfung stellt um Variablen zu implementieren,
Dazu kann das Objekt **logic** genutzt werden, welches SmartHomeNG zur Verfüfung stellt, um Variablen zu implementieren,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verfüfung => Verfügung

entsprechenden ``<name>.yaml.default`` Dateien umkopiert.

Es werden die Konfigurationsdateienb **smarthome.yaml** und **logging.yaml** eingelesen und das Logging wird
Es werden die Konfigurationsdateienb ``smarthome.yaml`` und ``logging.yaml`` eingelesen und das Logging wird
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Konfigurationsdateienb

==========================

Die Python Dateien mit den Funktionen müssen dazu im Verzeichnis **../functions** abgelegt werden. Es sind normale
Die Python Dateien mit den Funktionen müssen dazu im Verzeichnis ``../functions`` abgelegt werden. Es sind normale
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

../functions oder functions oder etc/functions

@@ -13,10 +13,10 @@ von SmartHomeNG.
Die Kommunikation findet zwischen dem Browser und SmartHomeNG statt, NICHT zwischen dem
Webserver und SmartHomeNG. Der Webserver liefert nur den statischen Kontent der Visu aus.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kontent => Inhalt = HTML

@@ -120,7 +120,7 @@ Nun sollte so etwas ähnliches gezeigt werden:
smarthome@sh13:~$

Im obigen Fall handelt es sich beim laufenden eibd um eine Installation, die auf eine KNX
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eibd sollten wir rauswerfen, knxd ist seit Jahren etabliert. Wer meint noch einen eibd haben zu wollen braucht eh' keine Anleitung

@Morg42 Morg42 merged commit e2bea36 into smarthomeNG:develop Mar 29, 2026
4 checks passed
@Morg42 Morg42 deleted the doc branch March 29, 2026 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants