Repository navigation
docs: describe what the service needs to run - #16
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The README didn't say that the service depends on a broker, Zigbee2MQTT and a specific thermostat. Jan's idea.
What
A "Requirements" section in the README: required parts with the versions they were tested with, optional parts, and how to run it without Kubernetes.
How to validate
Read it. "Tested with" comes from the home cluster. Running the binary with
-configwas done locally against the real broker. The image with-configis how the chart runs it.Risk
Docs only.
docs:doesn't trigger a release.Rollback
Revert the PR.
🤖 Generated with Claude Code