EuleMitKeule/device-tools

Feature Request: Improve documentation

Aberta

#39 aberto em 3 de out. de 2025

Ver no GitHub
 (2 comentários) (4 reações) (0 responsável)Python (15 forks)auto 404
documentationhelp wanted

Métricas do repositório

Stars
 (264 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Examine o esquema de configuração para 'entities' no código e atualize o README ou a documentação para explicar seu propósito e comportamento.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80