docs(football-scoreboard): document all 177 settings, with real renders - #430
Open
ChuckBuilds wants to merge 2 commits into
Open
docs(football-scoreboard): document all 177 settings, with real renders#430ChuckBuilds wants to merge 2 commits into
ChuckBuilds wants to merge 2 commits into
Conversation
The README was long but incomplete: it documented perhaps half the settings, carried a "Version History" section still claiming v2.0.7 against a manifest at 3.4.1, and had no images. It now covers every schema leaf -- verified by a token audit -- with seven renders. Kept in full: dynamic team resolution and the AP_TOP_* warning, the rotation and resume semantics, the measured turnover example, the ranked/divisions reasoning including why broadcast was retired, the worked example, and the celebration banner table. Three things it did not say: - The mode toggles here are show_live / show_recent / show_upcoming, not live / recent / upcoming as in every other scoreboard. A display_modes block copied across silently sets nothing. - Five defaults differ between nfl and ncaa_fb -- enabled, live_game_duration, upcoming_games_to_show, other_upcoming_games_to_show and show_ranking. Documented as a table rather than duplicating 52 rows per league. - The live card's down-and-distance, red-zone colour, possession icon and timeout pips were undocumented, and are the plugin's most distinctive output. layout_mode: adaptive now has a side-by-side render against classic on a 128x64 panel, which is where the difference actually shows. Dropped the stale version-history section rather than correcting it; the manifest versions array is the real record. check_plugin.py passes 24/24 with no FAIL. Carries the docs-tooling changes from #423, which this render depends on. 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 | 18 |
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.
The rewrite collapsed the YouTube, Instagram, Discord and sponsorship links into a shields badge. They are the project owner support links, not decoration, so restore them verbatim at the top. Co-Authored-By: Claude Opus 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
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.
The football README was long but incomplete — roughly half the settings, no images, and a "Version History" section still claiming v2.0.7 against a manifest at 3.4.1. It now covers every schema leaf (token audit: 177 leaves, 0 undocumented) with seven renders.
Preserved in full
The existing README had genuinely good content and I kept it: dynamic team resolution with the
AP_TOP_*warning, the rotation and resume semantics, the measured 3-hour turnover example, theranked/divisions reasoning including whybroadcastwas retired, the worked UGA/AUB example, and the celebration banner table.Dropped only the stale version-history section — the manifest
versionsarray is the real record and the prose one was three minor versions behind.What it did not say
show_live/show_recent/show_upcoming, notlive/recent/upcomingas in every other scoreboard in this repo. Adisplay_modesblock copied across from nrl or lacrosse silently sets nothing and every mode stays at its default.nflandncaa_fb—enabled,live_game_duration,game_limits.upcoming_games_to_show,game_limits.other_upcoming_games_to_show, anddisplay_options.show_ranking. Documented as a five-row table with a<league>placeholder for everything else, rather than duplicating 52 rows per league.Renders
Seven images from
docs/assets/football-scoreboard/shots.json: hero, the three display modes, the three period states, the live-card detail (down/distance in yellow against red-zone red),show_recordson/off,layout_modeclassic vs adaptive on a 128x64 panel, and four panel sizes.The
layout_modecomparison is worth the space: on a tall panel, classic draws both crests at their fixed size and lets the score overlap the home logo, while adaptive scales them and keeps the score clear. That is the argument for the beta setting, and it was previously only prose.Real NFL crests throughout — the core ships the full
nfl_logosset.A correction to issue #426
I filed #426 saying every scoreboard's
other_games_min_qualitydescription offers abroadcastvalue the enum lacks. Football's copy is already correct — it explains thatbroadcastwas retired, why (it passed 174 of 175 games on a real slate), and that old configs are read asranked. That wording is the model; #426 applies to nrl and lacrosse only. I will update the issue.Checks
check_plugin.py: 24/24 PASS, zero FAILadditionalPropertiesconfig_schema.json, including the five per-league divergencesplugins.jsonregenerated byupdate_registry.pyDoes not touch the shared
sports.pylineage.Dependency
Carries the docs-tooling commits from #423 so this branch renders standalone; identical in both branches and they collapse on merge.
🤖 Generated with Claude Code