2 Commits

Author	SHA1	Message	Date
Chuck	49287bdd1a	docs: fix ADVANCED_FEATURES and REST_API_REFERENCE ... REST_API_REFERENCE.md - Wrong path: /fonts/delete/<font_family> -> /fonts/<font_family> (verified the real DELETE route in web_interface/blueprints/api_v3.py). - Diffed the documented routes against the real api_v3 blueprint (92 routes vs the 71 documented). Added missing sections: - Error tracking (/errors/summary, /errors/plugin/<id>, /errors/clear) - Health (/health) - Schedule dim/power (/config/dim-schedule GET/POST) - Plugin-specific endpoints (calendar/list-calendars, of-the-day/json/upload+delete, plugins/<id>/static/<path>) - Starlark Apps (12 endpoints: status, install-pixlet, apps CRUD, repository browse/install, upload) - Font preview (/fonts/preview) - Updated table of contents with the new sections. - Added a footer note that the API blueprint mounts at /api/v3 (app.py:144) and that SSE stream endpoints are defined directly on the Flask app at app.py:607-615. ADVANCED_FEATURES.md - Vegas Scroll Mode section was actually accurate (verified all config keys match src/vegas_mode/config.py:15-30). - On-Demand Display section had multiple bugs: - 5 occurrences of port 5050 -> 5000 - All API paths missing /v3 (e.g. /api/display/on-demand/start should be /api/v3/display/on-demand/start) - "Settings -> Plugin Management -> Show Now Button" UI flow doesn't exist. Real flow: open the plugin's tab in the second nav row, click Run On-Demand / Stop On-Demand. - "Python API Methods" section showed controller.show_on_demand() / clear_on_demand() / is_on_demand_active() / get_on_demand_info() — none of these methods exist on DisplayController. The on-demand machinery is all internal (_set_on_demand_*, _activate_on_demand, etc) and is driven through the cache_manager. Replaced the section with a note pointing to the REST API. - All Use Case Examples used the same fictional Python calls. Replaced with curl examples against the real API. - Cache Management section claimed "On-demand display uses Redis cache keys". LEDMatrix doesn't use Redis — verified with grep that src/cache_manager.py has no redis import. The cache is file-based, managed by CacheManager (file at /var/cache/ledmatrix/ or fallback paths). Rewrote the manual recovery section: - Removed redis-cli commands - Replaced cache.delete() Python calls with cache.clear_cache() (the real public method per the same bug already flagged in PLUGIN_API_REFERENCE.md) - Replaced "Settings -> Cache Management" with the real Cache tab - Documented the actual cache directory candidates - Background Data Service section: - Used "nfl_scoreboard" as the plugin id in the example. The real plugin is "football-scoreboard" (handles both NFL and NCAA). Fixed. - "Implementation Status: Phase 1 NFL only / Phase 2 planned" section was severely outdated. The background service is now used by all sports scoreboards (football, hockey, baseball, basketball, soccer, lacrosse, F1, UFC), the odds ticker, and the leaderboard plugin. Replaced with a current "Plugins using the background service" note. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>	2026-04-06 21:55:34 -04:00
Chuck	ddd300a117	Docs/consolidate documentation (#217) ... * docs: rename FONT_MANAGER_USAGE.md to FONT_MANAGER.md Renamed for clearer naming convention. Part of documentation consolidation effort. * docs: consolidate Plugin Store guides (2→1) Merged: - PLUGIN_STORE_USER_GUIDE.md - PLUGIN_STORE_QUICK_REFERENCE.md Into: PLUGIN_STORE_GUIDE.md - Unified writing style to professional technical - Added Quick Reference section at top for easy access - Removed duplicate content - Added cross-references to related documentation - Updated formatting to match style guidelines * docs: create user-focused Web Interface Guide Created WEB_INTERFACE_GUIDE.md consolidating: - V3_INTERFACE_README.md (technical details) - User-facing interface documentation - Focused on end-user tasks and navigation - Removed technical implementation details - Added common tasks section - Included troubleshooting - Professional technical writing style * docs: consolidate WiFi setup guides (4→1) Merged: - WIFI_SETUP.md - OPTIMAL_WIFI_AP_FAILOVER_SETUP.md - AP_MODE_MANUAL_ENABLE.md - WIFI_ETHERNET_AP_MODE_FIX.md (behavior documentation) Into: WIFI_NETWORK_SETUP.md - Comprehensive coverage of WiFi setup and configuration - Clear explanation of AP mode failover and grace period - Configuration scenarios and best practices - Troubleshooting section combining all sources - Professional technical writing style - Added quick reference table for behavior * docs: consolidate troubleshooting guides (4→1) Merged: - TROUBLESHOOTING_QUICK_START.md - WEB_INTERFACE_TROUBLESHOOTING.md - CAPTIVE_PORTAL_TROUBLESHOOTING.md - WEATHER_TROUBLESHOOTING.md Into: TROUBLESHOOTING.md - Organized by issue category (web, WiFi, plugins) - Comprehensive diagnostic commands reference - Quick diagnosis steps at the top - Service file template preserved - Complete diagnostic script included - Professional technical writing style * docs: create consolidated Advanced Features guide Merged: - VEGAS_SCROLL_MODE.md - ON_DEMAND_DISPLAY_QUICK_START.md - ON_DEMAND_DISPLAY_API.md - ON_DEMAND_CACHE_MANAGEMENT.md - BACKGROUND_SERVICE_README.md - PERMISSION_MANAGEMENT_GUIDE.md Into: ADVANCED_FEATURES.md - Comprehensive guide covering all advanced features - Vegas scroll mode with integration examples - On-demand display with API reference - Cache management troubleshooting - Background service documentation - Permission management patterns - Professional technical writing style * docs: create Getting Started guide for first-time users Created GETTING_STARTED.md: - Quick start guide (5 minutes) - Initial configuration walkthrough - Common first-time issues and solutions - Next steps and quick reference - User-friendly tone for beginners - Links to detailed documentation * docs: archive consolidated source files and ephemeral docs Archived files that have been consolidated: - Plugin Store guides (2 files → PLUGIN_STORE_GUIDE.md) - Web Interface guide (V3_INTERFACE_README.md → WEB_INTERFACE_GUIDE.md) - WiFi Setup guides (4 files → WIFI_NETWORK_SETUP.md) - Troubleshooting guides (4 files → TROUBLESHOOTING.md) - Advanced Features (6 files → ADVANCED_FEATURES.md) Archived ephemeral/debug documentation: - DEBUG_WEB_ISSUE.md - BROWSER_ERRORS_EXPLANATION.md - FORM_VALIDATION_FIXES.md - WEB_UI_RELIABILITY_IMPROVEMENTS.md - CAPTIVE_PORTAL_TESTING.md - NEXT_STEPS_COMMANDS.md - STATIC_IMAGE_MULTI_UPLOAD_PLAN.md - RECONNECT_AFTER_CAPTIVE_PORTAL_TESTING.md Archived implementation summaries: - PLUGIN_CONFIG_TABS_SUMMARY.md - PLUGIN_CONFIG_SYSTEM_VERIFICATION.md - PLUGIN_SCHEMA_AUDIT_SUMMARY.md - STARTUP_OPTIMIZATION_SUMMARY.md - PLUGIN_DISPATCH_IMPLEMENTATION.md - NESTED_SCHEMA_IMPLEMENTATION.md - AP_MODE_MANUAL_ENABLE_CHANGES.md - PLUGIN_CONFIG_SYSTEM_EXPLANATION.md Total archived: 27 files Preserves git history while cleaning up main docs directory * docs: rename API_REFERENCE.md to REST_API_REFERENCE.md Renamed for clarity - this is specifically the REST API reference for the web interface, not a general API reference. * docs: update README.md to reflect consolidated documentation structure Updated documentation index: - Reflects new consolidated guides (51 → 16-17 files) - Updated Quick Start sections with new file names - Added consolidation history (January 2026) - Updated file references (API_REFERENCE → REST_API_REFERENCE) - Documented archival of 33 files - Added benefits of consolidation - Updated statistics and highlights - Removed outdated references - Professional writing style maintained throughout * docs: add Vegas scroll mode system architecture documentation Added comprehensive internal architecture section for Vegas mode: - Component overview with diagram - VegasModeCoordinator responsibilities and main loop - StreamManager buffering strategy and content flow - PluginAdapter integration and fallback behavior - RenderPipeline 125 FPS rendering process - Component interaction flows - Thread safety patterns - Performance characteristics Covers: - How the four components work together - Initialization and render loop flows - Config update handling - Frame rate management and optimization - Memory usage and CPU characteristics --------- Co-authored-by: Chuck <chuck@example.com>	2026-01-29 10:32:00 -05:00