mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-19 00:56:16 +00:00
The TestDocsConsistency walk only iterated [".", "guides", "reference",
"analysis"] — concepts/ was silently invisible, which is why
amazon-music-oauth.md slipped into the tree without a SUMMARY entry.
Refactored to walk the entire docs/ tree, with a small dirsToSkip
allow-list (_includes, archive, diagrams, images) for asset trees.
New top-level narrative directories are picked up automatically;
only asset dirs need an explicit entry.
The wider walk surfaced six previously-hidden concepts/* files. Five
older planning artefacts ("Enhanced State Management System",
"Upstream Bose Service Simulation") moved into docs/archive/ where
the dirsToSkip already excludes them; concepts/README.md renamed to
upstream-service-simulation-overview.md since "README.md" inside
archive/ would be misleading. Spotify Overview and Amazon Music
OAuth are user-facing narrative docs and are now linked under
Concepts in SUMMARY.md.
Note: concepts/streborn-patterns.md is internal review notes (its
own opening line says so) and is currently unlinked from SUMMARY.md;
will be handled separately by the maintainer.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
5.3 KiB
5.3 KiB
Table of Contents
User Guides
- Device-Local Install Journeys
- Cloud Shutdown Survival Guide
- Self-Hosting AfterTouch
- Connecting Music Services
- Migration & Safety Guide
- CLI Reference
- Backup Tool
- Getting Started
- SoundTouch Service
- Initial Device Setup
- Capture Device Pairing Traffic
- Capture Migration Traffic
- Device Setup Flow
- MAC Address Mapping
- HTTPS Setup
- Deployment
- Raspberry Pi Guide
- Troubleshooting
- IoT Implementation Guide
- Migration Guide
- MQTT Integration Design
- Useful Links
Useful Links
Technical Reference
- API Cookbook
- API Endpoints
- Spotify Account Addition
- Cloud API Emulation
- System Endpoints
- Speaker Endpoint
- WebSocket Events
- Device Pairing Flow
- Discovery
- Zone Management
- Preset Management
- Source Selection
- Volume Controls
- RadioBrowser
- Bass Controls
- Key Controls
- Feature Mapping
Concepts
- Request Recording
- Spotify Overview
- Spotify Priming Strategy
- Spotify OAuth
- Amazon Music OAuth
- Encrypted Export
- Diagnostic Export (Maintainer Setup)
- soundtouch-web Roadmap
Analysis & Research
- API Coverage Analysis
- Supported URLs
- Upstream URLs
- Anonymization Summary
- Device Redirect Methods
- Telnet (Port 17000) Migration Method
- Telnet Command Reference
- Setup WebSocket Experiment
- Factory Reset Protocol
- Wiki API Comparison
- IoT Config Summary
- IoT Configuration Analysis
- Bose Lab Runbook
- Missing Routes Spotify
- Bose App ADB Emulator
- Community Tools
Parity Analysis
Appendix (Other Documents)
- External Services Abstraction
- API Navigation Reference
- Claude Instructions
- Content Selection Implementation
- Device Customization Setup
- Device Logging
- Feature History
- Host/Port Parsing
- Manual Network Discovery
- Navigation Guide
- Official API Verification
- Preset Quickstart
- Project Patterns
- Service Availability Implementation
- SoundTouch Service Announcement
- Undocumented Community Features
- Unimplemented Endpoints
- Preset Store
- SCMUDC Enrichment Implementation
- Device Lifecycle and Power On Enhancement
- Device Lifecycle Summary
- Power On Implementation Guide
- SCMUDC Events Analysis
- Parity Improvements
- Parity SoundCork
- Stockholm Port Guide