EuleMitKeule/device-tools

Feature Request: Improve documentation

Ouverte

#39 ouverte le 3 oct. 2025

Voir sur GitHub
 (2 commentaires) (4 réactions) (0 personne assignée)Python (15 forks)auto 404
documentationhelp wanted

Métriques du dépôt

Stars
 (264 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Examinez le schema de configuration des 'entities' dans le code et mettez à jour le README ou la documentation pour expliquer son but et son comportement.
Stack technique
python
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80