EuleMitKeule/device-tools

Feature Request: Improve documentation

Aperta

#39 aperta il 3 ott 2025

Vedi su GitHub
 (2 commenti) (4 reazioni) (0 assegnatari)Python (15 fork)auto 404
documentationhelp wanted

Metriche repository

Star
 (264 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina lo schema di configurazione per 'entities' nel codice e aggiorna il README o la documentazione per spiegare il suo scopo e comportamento.
Tech stack
python
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80