2 Commits

Author	SHA1	Message	Date
Chuck	b374bfa8c6	docs: fix plugin config + store + dependency docs ... PLUGIN_STORE_GUIDE.md - 19 occurrences of port 5050 -> 5000 - All API paths missing /v3 (e.g. /api/plugins/install -> /api/v3/plugins/install). Bulk fix. PLUGIN_REGISTRY_SETUP_GUIDE.md - Same port + /api/v3 fixes (3 occurrences each) - "Go to Plugin Store tab" -> "Open the Plugin Manager tab and scroll to the Install from GitHub section" (the real flow for registry setup is the GitHub install section, not the Plugin Store search) PLUGIN_CONFIG_QUICK_START.md - Port 5001 -> 5000 (5001 is the dev_server.py default, not the web UI) - "Plugin Store tab" install flow -> real Plugin Manager + Plugin Store section + per-plugin tab in second nav row - Removed reference to PLUGIN_CONFIG_TABS_SUMMARY.md (archived doc) PLUGIN_CONFIGURATION_TABS.md - "Plugin Management vs Configuration" section confusingly described a "Plugins Tab" that doesn't exist as a single thing. Rewrote to describe the real two-piece structure: Plugin Manager tab (browse, install, toggle) vs per-plugin tabs (configure individual plugins). PLUGIN_DEPENDENCY_GUIDE.md - Port 5001 -> 5000 PLUGIN_DEPENDENCY_TROUBLESHOOTING.md - Wrong port (8080) and wrong UI nav ("Plugin Store or Plugin Management"). Fixed to the real flow. PLUGIN_QUICK_REFERENCE.md - "Plugin Location: ./plugins/ directory" -> default is plugin-repos/ (verified in config/config.template.json:130 and display_controller.py:132). plugins/ is a fallback. - File structure diagram showed plugins/ -> plugin-repos/. - Web UI install flow: "Plugin Store tab" -> "Plugin Manager tab -> Plugin Store section". Also fixed Configure ⚙️ button (doesn't exist) and "Drag and drop reorder" (not implemented). - API examples: replaced ad-hoc Python pseudocode with real curl examples against /api/v3/plugins/* endpoints. Pointed at REST_API_REFERENCE.md for the full list. - "Migration Path Phase 1-5" was a roadmap written before the plugin system shipped. The plugin system is now stable and live. Removed the migration phases as they're history, not a roadmap. - "Quick Migration" section called scripts/migrate_to_plugins.py which doesn't exist anywhere in the repo. Removed. - "Plugin Registry Structure" referenced ChuckBuilds/ledmatrix-plugin-registry which doesn't exist. The real registry is ChuckBuilds/ledmatrix-plugins. Fixed. - "Next Steps" / "Questions to Resolve" sections were pre-implementation planning notes. Replaced with a "Known Limitations" section that documents the actually-real gaps (sandboxing, resource limits, ratings, auto-updates). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>	2026-04-06 22:10:05 -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