Skip to content

Conversation

@felipecrs
Copy link
Contributor

@felipecrs felipecrs commented May 3, 2025

@AlexxIT, I went through the README and made some updates:

  1. Renamed Hass to Home Assistant, as per Home Assistant project preferences. I did the same in Frigate.
  2. Remove references to Lovelace, as Home Assistant project prefers to call it Dashboard
  3. Update some links like Frigate Card -> Advanced Camera Card
  4. Update config dir example to /homeassistant which is what more modern add-ons will use (like Frigate 0.16). EDIT: reverted this part.
  5. Removed references to RTSPToWebRTC as that integration was removed from newer Home Assistant versions in favor of the built-in go2rtc integration
  6. Mention Home Assistant built-in go2rtc integration in some places
  7. Consolidated all 2-way, two way, and two-way terminologies into two-way.
  8. Consolidated add-on, Add-on, and addon terminologies into add-on.
  9. Fixed a bunch of Markdownlint violations
  10. Some other minor stuff
  11. Replace hardcoded links to repository files with relative links, which are git tag-aware (i.e. will not redirect to master if viewing the documentation for a specific git tag)

I hope you like it.

@AlexxIT AlexxIT self-assigned this May 4, 2025
@AlexxIT
Copy link
Owner

AlexxIT commented May 22, 2025

  1. It's better not to change source and module name. Because this name used in config.
  2. In other places (ex. Home Assistant Add-on) are fine
  3. I'm not sure about changes path to config dir /homeassistant. This should be tested carefully.

@felipecrs
Copy link
Contributor Author

felipecrs commented May 22, 2025

@AlexxIT, thanks a lot for looking into it.


  1. Note I did not rename the YAML examples itself, they still point to hass:. I honestly think it looks more professional this way. But you decide, just say the word and I'll revert it.

  1. I will revert this, we can discuss it in the future.

@felipecrs
Copy link
Contributor Author

felipecrs commented Jul 7, 2025

  1. It's better not to change source and module name. Because this name used in config.

@AlexxIT I reverted this. I believe all your concerns are sorted now.


Also, I fixed all conflicts caused by #1773.

And additionally, I refactored all occurrences of 2-way and two way terminology into two-way. Also refactored Add-on into add-on.

@felipecrs
Copy link
Contributor Author

@ehn maybe you can help review this PR too. :)

@ehn
Copy link
Contributor

ehn commented Jul 10, 2025

@ehn maybe you can help review this PR too. :)

Looks good to me. :)

@felipecrs
Copy link
Contributor Author

@AlexxIT I updated the PR description to highlight everything this PR does. I hope that helps reviewing it.

Copy link
Contributor

@ehn ehn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me.

@felipecrs
Copy link
Contributor Author

@AlexxIT I don’t want to bother you, but it might be a good time to take a look at this PR.

It improves the appearance and consistency of the README, so the sooner it’s merged, the better for new readers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants