EuleMitKeule/device-tools

Feature Request: Improve documentation

Open

#39 opened on Oct 3, 2025

View on GitHub
 (2 comments) (4 reactions) (0 assignees)Python (15 forks)auto 404
documentationhelp wanted

Repository metrics

Stars
 (264 stars)
PR merge metrics
 (No merged PRs in 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.

Contributor guide

Research direction
Examine the configuration schema for 'entities' in the codebase and update the README or documentation to explain its purpose and behavior.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80