From e3c9e1aee8d6e2b5df8c159b15e774666c657fba Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Tue, 24 Jun 2025 20:29:48 -0500 Subject: [PATCH 1/2] Add section outlining entity creation guidelines --- docs/contributing/code.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/contributing/code.md b/docs/contributing/code.md index 5705a1c..6b6bc1c 100644 --- a/docs/contributing/code.md +++ b/docs/contributing/code.md @@ -85,6 +85,19 @@ In general, we try to avoid use of external libraries. well-known `set_timeout` method is also available; this can be a handy alternative to implementing a state machine. +#### Components/platforms and entities + +- Components/platforms should pass data from hardware directly through to the respective entities presented in the + front end (Home Assistant, MQTT, web, etc.). If the raw data requires grooming, this should be left to the user to do + by way of the various types of filters available + ([sensor](https://esphome.io/components/sensor/#sensor-filters), + [binary sensor](https://esphome.io/components/binary_sensor/#binary-sensor-filters), + [text sensor](https://esphome.io/components/text_sensor/#text-sensor-filters)). +- Components/platforms should facilitate the creation of entities only when there is a corresponding hardware feature + which the entity may control. Put another way, in general, do not introduce platforms which allow tuning + component/platform behavior when there is no corresponding feature implemented in the hardware the + component/platform is for. + #### General - All entities must be *optional* in the configuration. From 3aa33c981db2601f7f9d251b5ae08f691f8722b9 Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Wed, 25 Jun 2025 16:23:15 -0500 Subject: [PATCH 2/2] Add `netlify.toml` --- netlify.toml | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 netlify.toml diff --git a/netlify.toml b/netlify.toml new file mode 100644 index 0000000..c0bfb25 --- /dev/null +++ b/netlify.toml @@ -0,0 +1,4 @@ +[build] + publish = "site" + command = "mkdocs build" + environment = { PYTHON_VERSION = "3.13" }