mirror of https://github.com/ChuckBuilds/LEDMatrix.git synced 2026-04-10 13:02:59 +00:00

Files

Chuck eba2d4a711 docs: address CodeRabbit review comments on #306

Reviewed all 12 CodeRabbit comments on PR #306, verified each against
the current code, and fixed the 11 valid ones. The 12th finding is a
real code bug (cache_manager.delete() calls in api_helper.py and
resource_monitor.py) that's already in the planned follow-up code-fix
PR, so it stays out of this docs PR.

Fixed:

.cursor/plugins_guide.md, .cursor/README.md, .cursorrules
- I claimed "there is no --emulator flag" in 3 places. Verified in
  run.py:19-20 that the -e/--emulator flag is defined and functional
  (it sets os.environ["EMULATOR"]="true" before the display imports).
  Other docs I didn't touch (.cursor/plugin_templates/QUICK_START.md,
  docs/PLUGIN_DEVELOPMENT_GUIDE.md) already use the flag correctly.
  Replaced all 3 wrong statements with accurate guidance that
  both forms work and explains the CLI flag's relationship to the
  env var.

.cursorrules, docs/GETTING_STARTED.md, docs/WEB_INTERFACE_GUIDE.md,
docs/PLUGIN_DEVELOPMENT_GUIDE.md
- Four places claimed "the plugin loader also falls back to plugins/".
  Verified that PluginManager.discover_plugins()
  (src/plugin_system/plugin_manager.py:154) only scans the
  configured directory — no fallback. The fallback to plugins/
  exists only in two narrower places: store_manager.py:1700-1718
  (store install/update/uninstall operations) and
  schema_manager.py:70-80 (schema lookup for the web UI form
  generator). Rewrote all four mentions with the precise scope.
  Added a recommendation to set plugin_system.plugins_directory
  to "plugins" for the smoothest dev workflow with
  dev_plugin_setup.sh symlinks.

docs/FONT_MANAGER.md
- The "Status" warning told plugin authors to use
  display_manager.font_manager.resolve_font(...) as a workaround for
  loading plugin fonts. Verified in src/font_manager.py that
  resolve_font() takes a family name, not a file path — so the
  workaround as written doesn't actually work. Rewrote to tell
  authors to load the font directly with PIL or freetype-py in their
  plugin.
- The same section said "the user-facing font override system in the
  Fonts tab still works for any element that's been registered via
  register_manager_font()". Verified in
  web_interface/blueprints/api_v3.py:5404-5428 that
  /api/v3/fonts/overrides is a placeholder implementation that
  returns empty arrays and contains "would integrate with the actual
  font system" comments — the Fonts tab does not have functional
  integration with register_manager_font() or the override system.
  Removed the false claim and added an explicit note that the tab
  is a placeholder.

docs/ADVANCED_FEATURES.md:523
- The on-demand section said REST/UI calls write a request "into the
  cache manager (display_on_demand_config key)". Wrong — verified
  via grep that api_v3.py:1622 and :1687 write to
  display_on_demand_request, and display_on_demand_config is only
  written by the controller during activation
  (display_controller.py:1195, cleared at :1221). Corrected the key
  name and added controller file:line references so future readers
  can verify.

docs/ADVANCED_FEATURES.md:803
- "Plugins using the background service" paragraph listed all
  scoreboard plugins but an orphaned "⏳ MLB (baseball)" bullet
  remained below from the old version of the section. Removed the
  orphan and added "baseball/MLB" to the inline list for clarity.

web_interface/README.md
- The POST /api/v3/system/action action list was incomplete. Verified
  in web_interface/app.py:1383,1386 that enable_autostart and
  disable_autostart are valid actions. Added both.
- The Plugin Store section was missing
  GET /api/v3/plugins/store/github-status (verified at
  api_v3.py:3296). Added it.
- The SSE line-range reference was app.py:607-615 but line 619
  contains the "Exempt SSE streams from CSRF and add rate limiting"
  block that's semantically part of the same feature. Extended the
  range to 607-619.

docs/GETTING_STARTED.md
- Rows/Columns step said "Columns: 64 or 96 (match your hardware)".
  The web UI's validation accepts any integer in 16-128. Clarified
  that 64 and 96 are the common bundled-hardware values but the
  valid range is wider.

Not addressed (out of scope for docs PR):

- .cursorrules:184 CodeRabbit comment flagged the non-existent
  cache_manager.delete() calls in src/common/api_helper.py:287 and
  src/plugin_system/resource_monitor.py:343. These are real CODE
  bugs, not doc bugs, and they're the first item in the planned
  post-docs-refresh code-cleanup PR (see
  /home/chuck/.claude/plans/warm-imagining-river.md). The docs in
  this PR correctly state that delete() doesn't exist on
  CacheManager — the fix belongs in the follow-up code PR that
  either adds a delete() shim or updates the two callers.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-04-07 19:11:41 -04:00

README.md

LEDMatrix Documentation

This directory contains guides, references, and architectural notes for the LEDMatrix project. If you are setting up a Pi for the first time, start with the project root README — it covers hardware, OS imaging, and the one-shot installer. The pages here go deeper.

I'm a new user

GETTING_STARTED.md — first-time setup walkthrough
WEB_INTERFACE_GUIDE.md — using the web UI
PLUGIN_STORE_GUIDE.md — installing and managing plugins
WIFI_NETWORK_SETUP.md — WiFi and AP-mode setup
TROUBLESHOOTING.md — common issues and fixes
SSH_UNAVAILABLE_AFTER_INSTALL.md — recovering SSH after install
CONFIG_DEBUGGING.md — diagnosing config problems

I want to write a plugin

Start here:

PLUGIN_DEVELOPMENT_GUIDE.md — end-to-end workflow
PLUGIN_QUICK_REFERENCE.md — cheat sheet
PLUGIN_API_REFERENCE.md — display, cache, and plugin-manager APIs
PLUGIN_ERROR_HANDLING.md — error-handling patterns
DEV_PREVIEW.md — preview plugins on your dev machine without a Pi
EMULATOR_SETUP_GUIDE.md — running the matrix emulator

Going deeper:

ADVANCED_PLUGIN_DEVELOPMENT.md — advanced patterns
PLUGIN_ARCHITECTURE_SPEC.md — full plugin-system spec
PLUGIN_DEPENDENCY_GUIDE.md / PLUGIN_DEPENDENCY_TROUBLESHOOTING.md
PLUGIN_WEB_UI_ACTIONS.md (+ example JSON)
PLUGIN_CUSTOM_ICONS.md / PLUGIN_CUSTOM_ICONS_FEATURE.md
PLUGIN_REGISTRY_SETUP_GUIDE.md (+ registry template)
STARLARK_APPS_GUIDE.md — Starlark-based mini-apps
widget-guide.md — widget development

Configuring plugins

PLUGIN_CONFIG_QUICK_START.md — minimal config you need
PLUGIN_CONFIGURATION_GUIDE.md — schema design
PLUGIN_CONFIGURATION_TABS.md — multi-tab UI configs
PLUGIN_CONFIG_ARCHITECTURE.md — how the config system works
PLUGIN_CONFIG_CORE_PROPERTIES.md — properties every plugin honors

Advanced features

ADVANCED_FEATURES.md — Vegas scroll, on-demand display, cache management, background services, permissions
FONT_MANAGER.md — font system

Reference

REST_API_REFERENCE.md — all web-interface HTTP endpoints
PLUGIN_API_REFERENCE.md — Python APIs available to plugins
DEVELOPER_QUICK_REFERENCE.md — common dev tasks
PLUGIN_IMPLEMENTATION_SUMMARY.md — what the plugin system actually does

Contributing to LEDMatrix itself

DEVELOPMENT.md — environment setup
HOW_TO_RUN_TESTS.md — running the test suite
MULTI_ROOT_WORKSPACE_SETUP.md — multi-repo workspace
MIGRATION_GUIDE.md — breaking changes between releases

Contributing to the docs

Markdown only, professional tone, minimal emoji.
Prefer adding to an existing page over creating a new one. If you add a new page, link it from this index in the section it belongs to.
If a page becomes obsolete, move it to docs/archive/ rather than deleting it, so links don't rot.
Keep examples runnable — paths, commands, and config keys here should match what's actually in the repo.