docs(pomodoro-timer): give every setting its config.json key - #384
Open
ChuckBuilds wants to merge 1 commit into
Open
docs(pomodoro-timer): give every setting its config.json key#384ChuckBuilds wants to merge 1 commit into
ChuckBuilds wants to merge 1 commit into
Conversation
The README documented all 46 settings by their web-UI label only -- "Font", "Burndown Indicator", "How Paused Looks" -- so none of the JSON keys appeared anywhere. Anyone editing config/config.json directly, or reading a key back out of a log line, had no way to map one to the other. Every table now carries the key beside the label. Two claims corrected while checking them against the core's config template: "enabled" is the toggle in the tab header, not a field in the form, and the advanced settings are grouped into a collapsed "Advanced Settings" section rather than hidden behind a toggle. The plugin was also missing from the root README's plugin listing entirely, so it gains a Productivity section. update_readme_previews.py now looks for a plugin-local assets/hero.png as well as docs/assets/<id>/hero.png, since this plugin ships its own renderer and keeps its images beside the plugin. No functional change; check_plugin.py passes 8/8 with all four goldens matching. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
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
1 participant
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.
What was missing
The pomodoro README is already one of the strongest in the repo — real rendered screenshots, an MQTT reference, Home Assistant automation examples. But it documented all 46 settings by their web-UI label only:
Not one of the 46 JSON keys appeared anywhere in the file. Anyone editing
config/config.jsondirectly, or reading a key back out of a log line, had nothing to mapfont_path↔ Font. Every other plugin README documents by key, so this was also the odd one out.All four tables now carry both:
Verified against the schema: 46 properties, 46 documented, none missing. Rows that cover several settings at once (the phase colours, the five labels, username/password) list each key.
Also added: the schema ranges that were absent (
work_minutes1–180,publish_interval_seconds1–60, labels 24 chars), and a minimalconfig.jsonexample.Two corrections
Checking the claims against
web_interface/templates/v3/partials/plugin_config.htmlin the core turned up two that were wrong:enabledis not a form field. The template explicitly skips it —{# Skip 'enabled' field - it's handled by the header toggle #}— so the table now says so rather than implying a checkbox in the list.x-advancedare grouped into one collapsed Advanced Settings section after the basic fields.Root README
The plugin was missing from the root README's Available Plugins listing entirely, so it gains a Productivity section with its hero preview.
update_readme_previews.pynow also looks forplugins/<id>/assets/hero.png, because this plugin ships its own renderer and keeps its images beside the plugin rather than indocs/assets/.Three other plugins are missing from that listing too — filed separately as #385.
Checks
check_plugin.py: 8/8 pass, all four goldens matchtest/render_readme_assets.pyre-run: the panels reproduce pixel-identically; the captions do not, which is Composite label fonts resolve to whatever the host has, so README images are only reproducible per-machine #383, not this PRDocs only. 1.3.4 → 1.3.5.
🤖 Generated with Claude Code