docs(incoming-packages): document all 25 settings, with real renders - #390
Merged
Conversation
The "Key options" table listed 7 of the 25 settings and pointed at config_schema.json for the rest, which meant the two thirds that shape what actually appears on a card -- show_dashboard, show_delivered, show_delivery_images, include_delivered, the scroll settings, the timezone override -- were undocumented. All 25 are now covered, grouped by connection, card contents, and rotation, with the advanced ones marked. The plugin had no images. It ships a mock provider precisely so the layout can be previewed without credentials, so every screenshot here comes from that: the three card types, four panel sizes, and before/after pairs for show_dashboard, highlight_today, show_carrier_logo and show_delivered. Each pair was hash-compared to confirm the setting actually changes the render. Adds the plugin to the root README, where it was missing (#385). That creates a Productivity section, which #384 also adds for pomodoro-timer -- whichever lands second needs the two rows merged into one section. Rendering used the shots "attrs" seam from #386, not yet on main; the identical tooling change is included so this branch renders on its own. 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 | 17 |
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 configuration section was a seven-row table called Key options, ending with "See
config_schema.jsonfor the full list". The eighteen rows it left out include most of the ones that decide what actually appears on a card:show_dashboard,show_delivered,show_delivery_images,show_usps_mail_image,include_delivered,show_carrier_logo,accent_color,customization.title_text.text_color,scroll_enabled,scroll_speed,scroll_separator,timezone,entity_prefix,stale_after_minutes,image_frame_seconds,max_cards,display_duration,enabled.All 25 are now documented, grouped into Connection, What appears on the cards, and Rotation and motion, with ranges and the advanced flag carried over from the schema. The config-token audit drops nothing.
Images
The plugin had none — but it ships a
mockprovider specifically so the layout can be previewed without credentials, so every screenshot is that provider running for real:in transit→in trans.)show_dashboard,highlight_today,show_carrier_logoandshow_deliveredEach pair was hash-compared to confirm the setting genuinely changes the output rather than being documented on faith:
The renders also confirm the sort order the README claims: UPS and USPS (arriving today) come before Amazon and FedEx (transit only).
Two merge notes
pomodoro-timer. Whichever lands second needs the two rows merged into one section; it is a two-line resolution.attrsseam from fix(on-air): find the real LEDMatrix root when loading the sign font #386, which is not on main yet, so the identical change tositecustomize.pyandrender_docs_assets.pyis included here.Checks
check_plugin.py: 6/6 pass (this plugin's harness defines its own size list)render_docs_assets.py --check: all seven images reproduceDocs only. 1.0.0 → 1.0.1.
🤖 Generated with Claude Code