mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-19 00:56:16 +00:00
- DEVICE-LOCAL-INSTALL.md: old path at docs/ root → docs/architecture/ - Add Deployment Overview + three walkthrough pages under User Guides - Add Architecture section for the planning doc
120 lines
5.6 KiB
Markdown
120 lines
5.6 KiB
Markdown
# Table of Contents
|
|
|
|
* [Introduction](README.md)
|
|
|
|
## User Guides
|
|
* [Deployment Overview](guides/DEPLOYMENT-OVERVIEW.md)
|
|
* [Local Network Host Walkthrough](guides/EXTERNAL-HOST-WALKTHROUGH.md)
|
|
* [Cloud / VPS Walkthrough](guides/CLOUD-DEPLOY-WALKTHROUGH.md)
|
|
* [On-Device Install Walkthrough](guides/ON-DEVICE-INSTALL-WALKTHROUGH.md)
|
|
* [Cloud Shutdown Survival Guide](guides/SURVIVAL-GUIDE.md)
|
|
* [Self-Hosting AfterTouch](guides/SELF-HOSTING.md)
|
|
* [Connecting Music Services](guides/MUSIC-SERVICES.md)
|
|
* [Migration & Safety Guide](guides/MIGRATION-SAFETY.md)
|
|
* [CLI Reference](guides/CLI-REFERENCE.md)
|
|
* [Backup Tool](../cmd/soundtouch-backup/README.md)
|
|
* [Getting Started](guides/GETTING-STARTED.md)
|
|
* [SoundTouch Service](guides/SOUNDTOUCH-SERVICE.md)
|
|
* [Initial Device Setup](guides/DEVICE-INITIAL-SETUP.md)
|
|
* [Capture Device Pairing Traffic](guides/CAPTURE-DEVICE-PAIRING.md)
|
|
* [Capture Migration Traffic](guides/CAPTURE-MIGRATION-TRAFFIC.md)
|
|
* [Device Setup Flow](DEVICE-SETUP.md)
|
|
* [MAC Address Mapping](guides/MAC-ADDRESS-MAPPING.md)
|
|
* [HTTPS Setup](guides/HTTPS-SETUP.md)
|
|
* [Deployment](guides/DEPLOYMENT.md)
|
|
* [Raspberry Pi Guide](guides/RASPBERRY-PI.md)
|
|
* [Troubleshooting](guides/TROUBLESHOOTING.md)
|
|
* [IoT Implementation Guide](guides/IOT-IMPLEMENTATION-GUIDE.md)
|
|
* [Migration Guide](guides/MIGRATION-GUIDE.md)
|
|
* [MQTT Integration Design](guides/MQTT-INTEGRATION-DESIGN.md)
|
|
* [Useful Links](#useful-links)
|
|
|
|
### Useful Links
|
|
* [Cloud Shutdown Survival Guide](guides/SURVIVAL-GUIDE.md)
|
|
* [Raspberry Pi Installer](../scripts/raspberry-pi/README.md)
|
|
* [Updating the Service](../scripts/raspberry-pi/README.md#updating-to-a-new-version)
|
|
* [CLI Reference](guides/CLI-REFERENCE.md)
|
|
|
|
## Technical Reference
|
|
* [API Cookbook](reference/API-COOKBOOK.md)
|
|
* [API Endpoints](reference/API-ENDPOINTS.md)
|
|
* [Spotify Account Addition](reference/spotify-account-addition.md)
|
|
* [Cloud API Emulation](reference/CLOUD-API.md)
|
|
* [System Endpoints](reference/SYSTEM-ENDPOINTS.md)
|
|
* [Speaker Endpoint](reference/SPEAKER-ENDPOINT.md)
|
|
* [WebSocket Events](reference/WEBSOCKET-EVENTS.md)
|
|
* [Device Pairing Flow](reference/DEVICE-PAIRING-FLOW.md)
|
|
* [Discovery](reference/DISCOVERY.md)
|
|
* [Zone Management](reference/ZONE-MANAGEMENT.md)
|
|
* [Preset Management](reference/PRESET-MANAGEMENT.md)
|
|
* [Source Selection](reference/SOURCE-SELECTION.md)
|
|
* [Volume Controls](reference/VOLUME-CONTROLS.md)
|
|
* [RadioBrowser](reference/radio-browser.md)
|
|
* [Bass Controls](reference/BASS-CONTROLS.md)
|
|
* [Key Controls](reference/KEY-CONTROLS.md)
|
|
* [Feature Mapping](reference/FEATURE-MAPPING.md)
|
|
|
|
## Concepts
|
|
* [Request Recording](REQUEST_RECORDING_CONCEPT.md)
|
|
* [Spotify Overview](concepts/spotify-overview.md)
|
|
* [Spotify Priming Strategy](concepts/spotify-priming-strategy.md)
|
|
* [Spotify OAuth](concepts/spotify-oauth.md)
|
|
* [Amazon Music OAuth](concepts/amazon-music-oauth.md)
|
|
* [Encrypted Export](concepts/ENCRYPTED-EXPORT.md)
|
|
* [Diagnostic Export (Maintainer Setup)](DIAGNOSTIC-EXPORT.md)
|
|
* [soundtouch-web Roadmap](soundtouch-web-roadmap.md)
|
|
|
|
## Architecture
|
|
* [Device-Local Install Journeys](architecture/DEVICE-LOCAL-INSTALL.md)
|
|
|
|
## Analysis & Research
|
|
* [API Coverage Analysis](analysis/API-COVERAGE.md)
|
|
* [Supported URLs](analysis/SUPPORTED-URLS.md)
|
|
* [Upstream URLs](analysis/UPSTREAM-URLS.md)
|
|
* [Anonymization Summary](analysis/ANONYMIZATION-SUMMARY.md)
|
|
* [Device Redirect Methods](analysis/DEVICE-REDIRECT-METHODS.md)
|
|
* [Telnet (Port 17000) Migration Method](analysis/TELNET-MIGRATION-METHOD.md)
|
|
* [Telnet Command Reference](analysis/TELNET-COMMAND-REFERENCE.md)
|
|
* [Setup WebSocket Experiment](analysis/SETUP-WEBSOCKET-EXPERIMENT.md)
|
|
* [Factory Reset Protocol](analysis/FACTORY-RESET-PROTOCOL.md)
|
|
* [Wiki API Comparison](analysis/WIKI-COMPARISON.md)
|
|
* [IoT Config Summary](analysis/IOT-CONFIG-SUMMARY.md)
|
|
* [IoT Configuration Analysis](analysis/IOT-CONFIGURATION-ANALYSIS.md)
|
|
* [Bose Lab Runbook](analysis/BOSE-LAB-RUNBOOK.md)
|
|
* [Missing Routes Spotify](analysis/MISSING-ROUTES-SPOTIFY.md)
|
|
* [Bose App ADB Emulator](analysis/BOSE-APP-ADB-Emulator.md)
|
|
* [Community Tools](analysis/bose-soundtouch-community-tools.md)
|
|
|
|
## Parity Analysis
|
|
* [Parity Improvements](PARITY-IMPROVEMENTS.md)
|
|
* [Parity SoundCork](PARITY-SOUNDCORK.md)
|
|
* [Parity OpenCloudTouch](PARITY-OPENCLOUDTOUCH.md)
|
|
|
|
## Appendix (Other Documents)
|
|
* [External Services Abstraction](EXTERNAL-SERVICES-ABSTRACTION.md)
|
|
* [API Navigation Reference](API-NAVIGATION-REFERENCE.md)
|
|
* [Claude Instructions](CLAUDE.md)
|
|
* [Content Selection Implementation](CONTENT-SELECTION-IMPLEMENTATION.md)
|
|
* [Device Customization Setup](DEVICE-CUSTOMIZATION-SETUP.md)
|
|
* [Device Logging](DEVICE-LOGGING.md)
|
|
* [Feature History](FEATURE_HISTORY.md)
|
|
* [Host/Port Parsing](HOST-PORT-PARSING.md)
|
|
* [Manual Network Discovery](MANUAL-NETWORK-DISCOVERY.md)
|
|
* [Navigation Guide](NAVIGATION-GUIDE.md)
|
|
* [Official API Verification](OFFICIAL-API-VERIFICATION.md)
|
|
* [Preset Quickstart](PRESET-QUICKSTART.md)
|
|
* [Project Patterns](PROJECT-PATTERNS.md)
|
|
* [Service Availability Implementation](SERVICE-AVAILABILITY-IMPLEMENTATION.md)
|
|
* [SoundTouch Service Announcement](SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md)
|
|
* [Undocumented Community Features](UNDOCUMENTED-COMMUNITY-FEATURES.md)
|
|
* [Unimplemented Endpoints](UNIMPLEMENTED-ENDPOINTS.md)
|
|
* [Preset Store](preset-store.md)
|
|
* [SCMUDC Enrichment Implementation](SCMUDC-ENRICHMENT-IMPLEMENTATION.md)
|
|
* [Device Lifecycle and Power On Enhancement](device-lifecycle-and-power-on-enhancement.md)
|
|
* [Device Lifecycle Summary](device-lifecycle-summary.md)
|
|
* [Power On Implementation Guide](power-on-implementation-guide.md)
|
|
* [SCMUDC Events Analysis](scmudc-events-analysis.md)
|
|
* [Parity Improvements](PARITY-IMPROVEMENTS.md)
|
|
* [Parity SoundCork](PARITY-SOUNDCORK.md)
|
|
* [Stockholm Port Guide](stockholm-port-guide.md)
|