93 lines
3.3 KiB
Markdown
93 lines
3.3 KiB
Markdown
|
# 📚 Soundwave Documentation
|
||
|
|
|
||
|
|
Complete documentation for the Soundwave audio archiving and streaming platform.
|
||
|
|
|
||
|
|
## 🚀 Getting Started
|
||
|
|
|
||
|
|
- [Quick Reference](QUICK_REFERENCE.md) - Quick start guide and command reference
|
||
|
|
- [Quick Launch](QUICK_LAUNCH.md) - Fast deployment guide
|
||
|
|
- [Quick Start](QUICKSTART.md) - Detailed setup instructions
|
||
|
|
|
||
|
|
## 🔧 Technical Documentation
|
||
|
|
|
||
|
|
### Core Features
|
||
|
|
- [Project Summary](PROJECT_SUMMARY.md) - Project overview and architecture
|
||
|
|
- [Data Persistence Fix](DATA_PERSISTENCE_FIX.md) - Database persistence implementation
|
||
|
|
- [Offline Playlists Guide](OFFLINE_PLAYLISTS_GUIDE.md) - PWA offline functionality
|
||
|
|
|
||
|
|
### PWA Features
|
||
|
|
- [PWA Complete](PWA_COMPLETE.md) - Complete PWA implementation
|
||
|
|
- [PWA Implementation](PWA_IMPLEMENTATION.md) - Technical PWA details
|
||
|
|
- [PWA Developer Guide](PWA_DEVELOPER_GUIDE.md) - Developer reference
|
||
|
|
- [PWA Testing Guide](PWA_TESTING_GUIDE.md) - Testing procedures
|
||
|
|
- [PWA Mobile Optimization](PWA_MOBILE_OPTIMIZATION.md) - Mobile-specific features
|
||
|
|
|
||
|
|
### Additional Features
|
||
|
|
- [Lyrics Feature](LYRICS_FEATURE.md) - Lyrics implementation
|
||
|
|
- [Lyrics Implementation Summary](LYRICS_IMPLEMENTATION_SUMMARY.md) - Lyrics details
|
||
|
|
- [Logo Integration](LOGO_INTEGRATION_COMPLETE.md) - Branding and logos
|
||
|
|
- [Logo Update](LOGO_UPDATE_COMPLETE.md) - Logo updates
|
||
|
|
- [Logo and Icons](LOGO_AND_ICONS.md) - Icon specifications
|
||
|
|
- [Themes](THEMES.md) - Theme customization
|
||
|
|
- [Artwork Implementation](IMPLEMENTATION_SUMMARY_ARTWORK.md) - Album artwork
|
||
|
|
|
||
|
|
## 🔒 Security & Audits
|
||
|
|
|
||
|
|
- [Security and PWA Audit](SECURITY_AND_PWA_AUDIT_COMPLETE.md) - Complete security audit
|
||
|
|
- [Audit Summary](AUDIT_SUMMARY_COMPLETE.md) - Latest audit results
|
||
|
|
- [Comprehensive Audit](COMPREHENSIVE_AUDIT_COMPLETE.md) - Full system audit
|
||
|
|
|
||
|
|
## 📋 Summaries & Reports
|
||
|
|
|
||
|
|
- [Complete PWA Summary](COMPLETE_PWA_SUMMARY.md) - PWA implementation summary
|
||
|
|
- [Build Optimization](BUILD_OPTIMIZATION.md) - Build and performance optimization
|
||
|
|
- [Folder Selection Guide](FOLDER_SELECTION_GUIDE.md) - Project structure guide
|
||
|
|
- [Pre-Launch Checklist](PRE_LAUNCH_CHECKLIST.md) - Deployment checklist
|
||
|
|
|
||
|
|
## 📝 Change Management
|
||
|
|
|
||
|
|
- [Change Log](CHANGELOG.md) - Recent changes and updates
|
||
|
|
- Version history and release notes
|
||
|
|
|
||
|
|
## 🛠️ Maintenance Scripts
|
||
|
|
|
||
|
|
See the [scripts/](../scripts/) directory for:
|
||
|
|
- `migrate.sh` - Database migration script
|
||
|
|
- `verify.sh` - System verification script
|
||
|
|
- `check_downloads.sh` - Download verification
|
||
|
|
|
||
|
|
## 🔗 Quick Links
|
||
|
|
|
||
|
|
### User Documentation
|
||
|
|
- Getting started → [Quick Launch](QUICK_LAUNCH.md)
|
||
|
|
- Offline features → [Offline Playlists Guide](OFFLINE_PLAYLISTS_GUIDE.md)
|
||
|
|
- PWA installation → [PWA Complete](PWA_COMPLETE.md)
|
||
|
|
|
||
|
|
### Developer Documentation
|
||
|
|
- API reference → [PWA Developer Guide](PWA_DEVELOPER_GUIDE.md)
|
||
|
|
- Architecture → [Project Summary](PROJECT_SUMMARY.md)
|
||
|
|
- Testing → [PWA Testing Guide](PWA_TESTING_GUIDE.md)
|
||
|
|
|
||
|
|
### Admin Documentation
|
||
|
|
- Deployment → [Data Persistence Fix](DATA_PERSISTENCE_FIX.md)
|
||
|
|
- Security → [Security and PWA Audit](SECURITY_AND_PWA_AUDIT_COMPLETE.md)
|
||
|
|
- Troubleshooting → [Quick Reference](QUICK_REFERENCE.md)
|
||
|
|
|
||
|
|
## 📊 Documentation Statistics
|
||
|
|
|
||
|
|
- Total documents: 26
|
||
|
|
- Quick starts: 3
|
||
|
|
- Technical guides: 12
|
||
|
|
- Feature docs: 7
|
||
|
|
- Audit reports: 3
|
||
|
|
- Maintenance: 1
|
||
|
|
|
||
|
|
## 🆕 Latest Updates
|
||
|
|
|
||
|
|
See [CHANGELOG.md](CHANGELOG.md) for the most recent changes and improvements.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Last Updated**: December 16, 2025
|
||
|
|
**Version**: 1.0.0
|