DrozmotiX / ioBroker.esphome

Control your ESP8266/ESP32 with simple yet powerful configuration files created and managed by ESPHome
MIT License
30 stars 23 forks source link

Dedicated Docs page outdated #202

Open SimonFischer04 opened 6 months ago

SimonFischer04 commented 6 months ago

The docs here https://drozmotix.github.io/languages/en/Adapter/ESPHome/ are pretty outdated with the recent changes.

How should we proceed here? Of course, we could "simply update it", but as a lot of the info is already in the README, wouldn't that be kind of duplicated and annoying to update 2 sources every time something changes?

DutchmanNL commented 4 months ago

The docs here https://drozmotix.github.io/languages/en/Adapter/ESPHome/ are pretty outdated with the recent changes.

How should we proceed here? Of course, we could "simply update it", but as a lot of the info is already in the README, wouldn't that be kind of duplicated and annoying to update 2 sources every time something changes?

honestly... struggling with a decision here .... im a still not 100% convinced if the separate docu page has an added value (as it has much more options than the GitHub readme, like language/navigation etc) or to keep all on git....

info should only be on one space, that's a fact and not duplicated or different. Question is, which source/layout etc is the best

my purpose of the docs page was to also have it in different languages and get more support from the communicate maintaining it. But, honestly, until this moment I did receive 4 pull request on the dock page (in global so not for this adapter specific but all information there sind that source exists) so my intention did not work out as planned :/

SimonFischer04 commented 4 months ago

honestly... struggling with a decision here .... im a still not 100% convinced if the separate docu page has an added value (as it has much more options than the GitHub readme, like language/navigation etc) or to keep all on git....

Yeah. Same struggle here - not sure whats the best way either, that was why I created the issue. Dedicated docs page has more features, but Readme is whats shown in the adapter info also...

info should only be on one space, that's a fact and not duplicated or different. Question is, which source/layout etc is the best

I 100% agree