finity69x2 / fan-control-entity-row

Provides a means to show a compact graphical control row for 2 or 3 speed fans in Home Assistant
68 stars 27 forks source link

docs gone wild #16

Closed pruchai closed 4 years ago

pruchai commented 4 years ago

There are 3 different places that tell you how to install this plugin and all 3 have different paths and plugin types.....

In this repo Screen Shot 2020-03-02 at 8 27 27 PM

In the community post Screen Shot 2020-03-02 at 8 27 55 PM

in HACS Screen Shot 2020-03-02 at 8 27 01 PM

what gives? can we get a single consistent source of truth?

finity69x2 commented 4 years ago

The thing is they are all "true".

it all depends on how you decide to install the plugin.

if you install it via HACS the follow those instructions.

if you install it manually then you have to place it somewhere in your /www/ folder. the exact path is up to you.

I have mine installed in the a /www/lovelace/ directory. Hence why I wrote ""modifying the directory for the location that you created the component" in the community post and "updating the location to where you placed the above file" in the instructions. It's up to you exactl;y where you place it as long as it's somewhere under the /config/www/ directory.

As far the /www/ vs /local/ difference that is the way that HA references files in the /www/ directory.

the physical location is "/config/www/" but it is referenced by "/local/".

None of this is a documentation problem per se. it's just an idiosyncrasy of how HA/HACS//etc. works.