From e1fa597b29bfabc1d1d98234a3c78c1e837f7968 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 6 Aug 2026 00:10:53 +0000 Subject: [PATCH] docs: archive the custom-icons status report, cross-link config docs, document assets/ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PLUGIN_CUSTOM_ICONS_FEATURE.md was a 'What Was Implemented' status report duplicating the actual guide (PLUGIN_CUSTOM_ICONS.md) — moved to docs/archive/ per the docs index's own policy. The overlapping plugin-config docs keep their content but PLUGIN_CONFIG_ARCHITECTURE.md now states up front which doc is canonical for which purpose. assets/README.md is new and load-bearing: assets/stocks, weather, news_logos and broadcast_logos have zero references in this repo's code, which makes them look deletable — but store plugins (ledmatrix-stocks, ledmatrix-weather, news, odds-ticker) resolve those exact paths at runtime against the install directory. The README records that evidence so a future cleanup doesn't break installed plugins. Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01SXb4mKcAkVaxkeTb3YnAdr --- assets/README.md | 22 +++++++++++++++++++ docs/PLUGIN_CONFIG_ARCHITECTURE.md | 6 +++++ docs/README.md | 3 +-- .../PLUGIN_CUSTOM_ICONS_FEATURE.md | 0 4 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 assets/README.md rename docs/{ => archive}/PLUGIN_CUSTOM_ICONS_FEATURE.md (100%) diff --git a/assets/README.md b/assets/README.md new file mode 100644 index 00000000..e88d7f0d --- /dev/null +++ b/assets/README.md @@ -0,0 +1,22 @@ +# assets/ + +Static assets bundled with LEDMatrix. **Do not delete these directories** — +several look unused from core code alone but are resolved at runtime by +installed store plugins. + +| Directory | Used by | +|---|---| +| `fonts/` | Core (`FontManager`, `DisplayManager`) and most plugins | +| `sports/` | Core logo tooling (`src/logo_downloader.py`) and the sports scoreboard plugins; team logos are downloaded here on demand | +| `stocks/` | `ledmatrix-stocks` plugin (`crypto_icons/`, `ticker_icons/`) | +| `weather/` | `ledmatrix-weather` plugin (weather icons) | +| `news_logos/` | `news` plugin | +| `broadcast_logos/` | `news` and `odds-ticker` plugins | +| `static_images/` | Legacy examples referenced in the `static-image` plugin's docs; the plugin itself stores uploads under `assets/plugins//uploads/` | +| `plugins/` | Per-plugin uploaded files (`assets/plugins//uploads/`), served by the web interface | + +Plugins resolve these paths relative to the LEDMatrix install directory, so +the directories are part of the de-facto plugin API even where no file in +this repo references them. New plugins should bundle their own assets or +use the per-plugin upload directory instead of adding top-level +directories here. diff --git a/docs/PLUGIN_CONFIG_ARCHITECTURE.md b/docs/PLUGIN_CONFIG_ARCHITECTURE.md index 28fa1ba3..823bb4db 100644 --- a/docs/PLUGIN_CONFIG_ARCHITECTURE.md +++ b/docs/PLUGIN_CONFIG_ARCHITECTURE.md @@ -1,5 +1,11 @@ # Plugin Configuration Tabs - Architecture +> This page covers internals (how the config system works under the +> hood). For designing a plugin's config schema, the canonical guide is +> [PLUGIN_CONFIGURATION_GUIDE.md](PLUGIN_CONFIGURATION_GUIDE.md); for +> the user-facing tabs feature, see +> [PLUGIN_CONFIGURATION_TABS.md](PLUGIN_CONFIGURATION_TABS.md). + ## System Architecture ### Component Overview diff --git a/docs/README.md b/docs/README.md index 0378deb0..acb2d944 100644 --- a/docs/README.md +++ b/docs/README.md @@ -33,8 +33,7 @@ Going deeper: - [PLUGIN_DEPENDENCY_GUIDE.md](PLUGIN_DEPENDENCY_GUIDE.md) / [PLUGIN_DEPENDENCY_TROUBLESHOOTING.md](PLUGIN_DEPENDENCY_TROUBLESHOOTING.md) - [PLUGIN_WEB_UI_ACTIONS.md](PLUGIN_WEB_UI_ACTIONS.md) (+ [example JSON](PLUGIN_WEB_UI_ACTIONS_EXAMPLE.json)) -- [PLUGIN_CUSTOM_ICONS.md](PLUGIN_CUSTOM_ICONS.md) / - [PLUGIN_CUSTOM_ICONS_FEATURE.md](PLUGIN_CUSTOM_ICONS_FEATURE.md) +- [PLUGIN_CUSTOM_ICONS.md](PLUGIN_CUSTOM_ICONS.md) - [PLUGIN_REGISTRY_SETUP_GUIDE.md](PLUGIN_REGISTRY_SETUP_GUIDE.md) (+ [registry template](plugin_registry_template.json)) - [STARLARK_APPS_GUIDE.md](STARLARK_APPS_GUIDE.md) — Starlark-based mini-apps - [widget-guide.md](widget-guide.md) — widget development diff --git a/docs/PLUGIN_CUSTOM_ICONS_FEATURE.md b/docs/archive/PLUGIN_CUSTOM_ICONS_FEATURE.md similarity index 100% rename from docs/PLUGIN_CUSTOM_ICONS_FEATURE.md rename to docs/archive/PLUGIN_CUSTOM_ICONS_FEATURE.md