search

AalianKhan / mushroom-strategy

A strategy to automatically generate a dashboard using mushroom cards
MIT License
364 stars 36 forks source link

Refactor readme to point to wiki #87

Closed AalianKhan closed 9 months ago

AalianKhan commented 9 months ago

Please also check the wiki to look for any mistakes

DigiLive commented 9 months ago

About the Wiki:

Since wiki by itself don't work with reviews or PR's, maybe we should use a construction like described at https://nimblehq.co/blog/create-github-wiki-pull-request. This might also come in handy if a PR requires changes to the wiki.

  1. [hacsUrl] is undefined for https://github.com/AalianKhan/mushroom-strategy/wiki#hacs. Also, keep in mind HACS 2.0 is coming soon and offered to users as a beta. It has another interface which don't match your current instructions.

  2. HACS is spelled like HACs at https://github.com/AalianKhan/mushroom-strategy/wiki#basic-setup Also, you could suggest to redownload the package with hacs besides the instruction to manually adding the reference.

  3. The link to Card Options at https://github.com/AalianKhan/mushroom-strategy/wiki/Adding-and-Hiding-entities-and-devices#hidding-specific-entities-and-devices doesn't work.

  4. At https://github.com/AalianKhan/mushroom-strategy/wiki/Strategy-Options#views: "All devices that are in an area where hidden is set to false/undefined are shown*" might be clearer when it's "Devices of a hidden area are excluded from the view. See Areas."

  5. At https://github.com/AalianKhan/mushroom-strategy/wiki/Strategy-Options#chips: "All devices that are in an area where hidden is set to false/undefined are counted." might be clearer when it's "Devices of a hidden area are excluded from the count." [mushroom-chipsUrl] is undefined for https://github.com/piitaya/lovelace-mushroom/blob/main/docs/cards/chips.md. Maybe tell we try to use the default weather entity if it's not defined here.

AalianKhan commented 9 months ago

Once again, Thank you very much for your very constructive feedback. I am gonna set the Wiki pull request soon.

DigiLive commented 9 months ago

@AalianKhan Maybe you want some of the changes of https://github.com/AalianKhan/mushroom-strategy/commit/c3047bbc003c9f770099b2302672cb9976c7564a also.

I had these changes ready before this PR came out. 😅

DigiLive commented 9 months ago

Changes are included in #81

DigiLive commented 8 months ago

@AalianKhan Can you decide on deleting the Move-docs-to-Wiki branch? The Wiki should be up to date at this moment.