docs: document sleep hours config and fix two README inaccuracies#111
Merged
Conversation
- Add led.sleep_start / sleep_end to the config.json example and add a dedicated "LED sleep hours" section explaining the midnight-wrap behaviour and the -1 disable sentinel - Correct the stated curl timeout from 10 s to 15 s (matches CURLOPT_TIMEOUT in weather.cpp) - Correct brightness in the config example to 0.05 (matches the actual default and config.json on disk) https://claude.ai/code/session_0166Zd59EUgWgYd3FrphQAio
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
2 participants
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.
Summary
Three documentation gaps found during the pre-release audit.
1. Sleep hours feature not documented
led.sleep_start/led.sleep_end— added in the last sprint — were missing from both theconfig.jsonexample and the Configuration section of the README. Added a dedicated LED sleep hours subsection explaining the midnight-wrap behaviour and the-1disable sentinel, and added the fields to the config example.2. Curl timeout figure wrong
The architecture table said "10s total timeout" but
weather.cppusesCURLOPT_TIMEOUT = 15L. Corrected to 15 s.3. LED brightness mismatch in example
The README example showed
brightness: 0.4whileconfig.jsonon disk (and the Config default) use0.05. Corrected to0.05.Changes
README.md: add LED sleep hours section; fix timeout from 10 s → 15 s; fix brightness from 0.4 → 0.05 in exampleTest plan
config.jsonkeys shown match what the code actually parses