EuleMitKeule/device-tools

Feature Request: Improve documentation

Offen

#39 geöffnet am 03.10.2025

Auf GitHub ansehen
 (2 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)Python (15 Forks)auto 404
documentationhelp wanted

Repository-Metriken

Stars
 (264 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Hi! First of all, thanks for the work!

I may be dumb but i don't find any documentation.

For example, what does "entities" part do in configutation...?

I tried to add a few entities, but nothing happened (?)

Also, what is the best practice to remove a configuration? I removed a test merged device, it broke everything, i can't find my original entities (but hey, there is an warning in your readme :) ) I removed it by first deselecting the devices to merge, and then remove the Device tools device.

Also, i saw that you have to reload the integration to apply modifications.

Contributor Guide

Research-Richtung
Untersuche das Konfigurationsschema für 'entities' im Code und aktualisiere die README oder Dokumentation, um dessen Zweck und Verhalten zu erklären.
Tech Stack
python
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80