mirror of https://github.com/ChuckBuilds/LEDMatrix.git synced 2026-08-06 03:08:05 +00:00

Files

T

Claude 4808132436 docs: correct semantically stale content across the user and developer guides

A second-pass content audit checked the guides' substantive claims
against the code (the first pass only fixed mechanical drift). Fixes:

- GETTING_STARTED: described booting a prebuilt SD image and seeing
  default clock/weather plugins — neither exists. Now documents the real
  install (Pi OS Lite + one-shot installer / first_time_install.sh) and
  that displays come from the Plugin Store. Duration and ordering
  instructions moved to the Rotation tab where the controls actually
  live.
- WEB_INTERFACE_GUIDE: three whole tabs were undocumented (Rotation,
  Backup & Restore, Tools) and the Display tab's Vegas Scroll section
  was unmentioned. Fonts overrides are per display element (not per
  plugin); Logs has an Auto-scroll checkbox (not a Pause button); the
  aspirational keyboard-shortcut list and no-JS claim removed.
- TROUBLESHOOTING: the hand-written service-file template (wrong user,
  wrong ExecStart, dropped the autostart gate) replaced with the real
  systemd/ units + install scripts; recovery steps no longer copy
  placeholder units verbatim; WiFi curl endpoint corrected to /api/v3/;
  cache-clearing advice now targets the real cache locations.
- ADVANCED_FEATURES: removed a false claim that CacheManager has no
  delete(); fixed two example snippets that raise TypeError
  (BackgroundDataService and get_config_file_mode signatures); fixed
  cache paths, a 5-minute TTL that is actually 1 hour, and the vegas
  table now links the complete 26-key reference.
- EMULATOR_SETUP_GUIDE: documented run.py flags that don't exist
  (--plugin/--test-plugins) removed in favor of dev_server.py and
  check_plugin.py; shipped emulator config values corrected (browser
  adapter default on :8888, not pygame).
- PLUGIN_QUICK_REFERENCE: drag-and-drop reordering is shipped, not
  'not yet supported'; discovery-fallback and registry-repo claims
  corrected. PLUGIN_API_REFERENCE: get_vegas_segment_width returns
  panels, not pixels. CONTRIBUTING: the repo uses flake8/mypy/bandit
  pre-commit hooks, not black/ruff, and tests need requirements-test.txt.
- SKIN_SYSTEM/DEVELOPER_QUICK_REFERENCE: stale module paths.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SXb4mKcAkVaxkeTb3YnAdr

2026-08-06 01:56:13 +00: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 — original plugin-system design spec (historical; see its banner for what has drifted)
PLUGIN_DEPENDENCY_GUIDE.md / PLUGIN_DEPENDENCY_TROUBLESHOOTING.md
PLUGIN_WEB_UI_ACTIONS.md (+ example JSON)
PLUGIN_CUSTOM_ICONS.md
PLUGIN_REGISTRY_SETUP_GUIDE.md (+ registry template)
STARLARK_APPS_GUIDE.md — Starlark-based mini-apps
widget-guide.md — widget development
ADAPTIVE_LAYOUT.md — render legibly on any panel size (opt-in font/layout scaling)
plugin-safety-harness.md — test a plugin across every screen and matrix size

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
SKIN_SYSTEM.md — skin architecture for sports scoreboards
CREATING_SKINS.md — writing and validating a skin

Reference

CONFIG_REFERENCE.md — every key in config.json and config_secrets.json
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
SPORTS_UNIFICATION.md — how the sports scoreboard base classes are organized

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.