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

Files

T

Claude 63076254d4 docs: fix broken links, phantom script references, and stale CI description

Repairs every broken relative link in active docs (targets renamed or
archived long ago: PLUGIN_DEVELOPMENT.md -> PLUGIN_DEVELOPMENT_GUIDE.md,
API_REFERENCE.md -> REST_API_REFERENCE.md, PLUGIN_STORE_USER_GUIDE.md ->
PLUGIN_STORE_GUIDE.md, plugin_docs/ dir, TROUBLESHOOTING_QUICK_START.md,
and MIGRATION_GUIDE's README link that silently resolved to the docs
index instead of the project README). Replaces commands invoking scripts
that do not exist (scripts/update_stats.py, validate_registry.py,
check_updates.py, fix_permissions.sh) with the real tooling, and
rewrites HOW_TO_RUN_TESTS.md's CI section, which described a
security-audit workflow that was never committed and a pytest workflow
'queued to land' that landed long ago as test.yml.

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

2026-08-05 23:57:40 +00:00

3.0 KiB

Raw Blame History

Migration Guide

This guide helps you migrate from older versions of LEDMatrix to the latest version.

Breaking Changes

Script Path Reorganization

Scripts have been reorganized into subdirectories for better organization. If you have automation, cron jobs, or custom tooling that references old script paths, you must update them.

Installation Scripts

All installation scripts have been moved from the project root to scripts/install/:

Old Path	New Path
`install_service.sh`	`scripts/install/install_service.sh`
`install_web_service.sh`	`scripts/install/install_web_service.sh`
`install_wifi_monitor.sh`	`scripts/install/install_wifi_monitor.sh`
`setup_cache.sh`	`scripts/install/setup_cache.sh`
`configure_web_sudo.sh`	`scripts/install/configure_web_sudo.sh`
`migrate_config.sh`	`scripts/install/migrate_config.sh`

Permission Fix Scripts

All permission fix scripts have been moved to scripts/fix_perms/:

Old Path	New Path
`fix_assets_permissions.sh`	`scripts/fix_perms/fix_assets_permissions.sh`
`fix_cache_permissions.sh`	`scripts/fix_perms/fix_cache_permissions.sh`
`fix_plugin_permissions.sh`	`scripts/fix_perms/fix_plugin_permissions.sh`
`fix_web_permissions.sh`	`scripts/fix_perms/fix_web_permissions.sh`

Action Required

Update cron jobs: If you have any cron jobs that call these scripts, update the paths.
Update automation scripts: Any custom scripts or automation that references the old paths must be updated.
Update documentation: Update any internal documentation or runbooks that reference these scripts.

Example Updates

Before:

# Old cron job or script
0 2 * * * /path/to/LEDMatrix/fix_cache_permissions.sh
sudo ./install_service.sh

After:

# Updated paths
0 2 * * * /path/to/LEDMatrix/scripts/fix_perms/fix_cache_permissions.sh
sudo ./scripts/install/install_service.sh

Verification

After updating your scripts, verify they still work:

# Test installation scripts (if needed)
ls scripts/install/*.sh
sudo ./scripts/install/install_service.sh --help

# Test permission scripts
ls scripts/fix_perms/*.sh
sudo ./scripts/fix_perms/fix_cache_permissions.sh

Other Changes

Configuration File Location

No changes to configuration file locations. The configuration system remains backward compatible.

Plugin System

The plugin system has been enhanced but remains backward compatible with existing plugins.

Getting Help

If you encounter issues during migration:

Check the project root README for current installation and usage instructions
Review script README files:
- scripts/install/README.md - Installation scripts documentation
- scripts/fix_perms/README.md - Permission scripts documentation
Check system logs: journalctl -u ledmatrix -f or journalctl -u ledmatrix-web -f
Review the troubleshooting section in the main README

3.0 KiB Raw Blame History