From 7d9f3d6a399cb9eba6c381bc0a2fa7413dc71193 Mon Sep 17 00:00:00 2001 From: Tobias Gesellchen Date: Mon, 25 May 2026 21:44:01 +0200 Subject: [PATCH] docs: remove duplicate H1 headings from 91 pages (closes #414) The docs framework renders frontmatter title: as the page heading. Every file that also had a matching # Heading as the first content line displayed the title twice. Removed the redundant H1 and its following blank line from all 91 affected files. Co-Authored-By: Claude Sonnet 4.6 --- docs/content/docs/analysis/ANONYMIZATION-SUMMARY.md | 3 --- docs/content/docs/analysis/API-COVERAGE.md | 3 --- docs/content/docs/analysis/BOSE-APP-ADB-Emulator.md | 3 --- docs/content/docs/analysis/BOSE-LAB-RUNBOOK.md | 3 --- docs/content/docs/analysis/DEVICE-REDIRECT-METHODS.md | 3 --- docs/content/docs/analysis/FACTORY-RESET-PROTOCOL.md | 3 --- docs/content/docs/analysis/IOT-CONFIG-SUMMARY.md | 3 --- docs/content/docs/analysis/IOT-CONFIGURATION-ANALYSIS.md | 3 --- docs/content/docs/analysis/MISSING-ROUTES-SPOTIFY.md | 3 --- docs/content/docs/analysis/SETUP-WEBSOCKET-EXPERIMENT.md | 3 --- docs/content/docs/analysis/SUPPORTED-URLS.md | 3 --- docs/content/docs/analysis/TELNET-COMMAND-REFERENCE.md | 3 --- docs/content/docs/analysis/TELNET-MIGRATION-METHOD.md | 3 --- docs/content/docs/analysis/UPSTREAM-URLS.md | 3 --- docs/content/docs/analysis/WIKI-COMPARISON.md | 3 --- docs/content/docs/analysis/bose-soundtouch-community-tools.md | 3 --- docs/content/docs/appendix/API-NAVIGATION-REFERENCE.md | 3 --- docs/content/docs/appendix/CLAUDE.md | 3 --- docs/content/docs/appendix/CONTENT-SELECTION-IMPLEMENTATION.md | 3 --- docs/content/docs/appendix/DEVICE-CUSTOMIZATION-SETUP.md | 3 --- docs/content/docs/appendix/DEVICE-LOGGING.md | 3 --- docs/content/docs/appendix/DEVICE-SETUP.md | 3 --- docs/content/docs/appendix/DIAGNOSTIC-EXPORT.md | 3 --- docs/content/docs/appendix/EXTERNAL-SERVICES-ABSTRACTION.md | 3 --- docs/content/docs/appendix/FEATURE_HISTORY.md | 3 --- docs/content/docs/appendix/HOST-PORT-PARSING.md | 3 --- docs/content/docs/appendix/MANUAL-NETWORK-DISCOVERY.md | 3 --- docs/content/docs/appendix/NAVIGATION-GUIDE.md | 3 --- docs/content/docs/appendix/OFFICIAL-API-VERIFICATION.md | 3 --- docs/content/docs/appendix/PARITY-OPENCLOUDTOUCH.md | 3 --- docs/content/docs/appendix/PARITY-SOUNDCORK.md | 3 --- docs/content/docs/appendix/PRESET-QUICKSTART.md | 3 --- docs/content/docs/appendix/PROJECT-PATTERNS.md | 2 -- docs/content/docs/appendix/REQUEST_RECORDING_CONCEPT.md | 3 --- docs/content/docs/appendix/SCMUDC-ENRICHMENT-IMPLEMENTATION.md | 3 --- .../docs/appendix/SERVICE-AVAILABILITY-IMPLEMENTATION.md | 3 --- docs/content/docs/appendix/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md | 3 --- docs/content/docs/appendix/UNDOCUMENTED-COMMUNITY-FEATURES.md | 2 -- docs/content/docs/appendix/UNIMPLEMENTED-ENDPOINTS.md | 3 --- .../docs/appendix/device-lifecycle-and-power-on-enhancement.md | 3 --- docs/content/docs/appendix/device-lifecycle-summary.md | 3 --- docs/content/docs/appendix/power-on-implementation-guide.md | 3 --- docs/content/docs/appendix/preset-store.md | 3 --- docs/content/docs/appendix/scmudc-events-analysis.md | 3 --- docs/content/docs/appendix/soundtouch-web-roadmap.md | 3 --- docs/content/docs/appendix/stockholm-port-guide.md | 3 --- docs/content/docs/architecture/DEVICE-LOCAL-INSTALL.md | 3 --- docs/content/docs/concepts/ENCRYPTED-EXPORT.md | 3 --- docs/content/docs/concepts/amazon-music-oauth.md | 3 --- docs/content/docs/concepts/spotify-oauth.md | 3 --- docs/content/docs/concepts/spotify-overview.md | 3 --- docs/content/docs/concepts/spotify-priming-strategy.md | 3 --- docs/content/docs/diagrams/migration-flow.md | 3 --- docs/content/docs/guides/CAPTURE-DEVICE-PAIRING.md | 3 --- docs/content/docs/guides/CAPTURE-MIGRATION-TRAFFIC.md | 3 --- docs/content/docs/guides/CLI-REFERENCE.md | 3 --- docs/content/docs/guides/CLOUD-DEPLOY-WALKTHROUGH.md | 3 --- docs/content/docs/guides/DEPLOYMENT-OVERVIEW.md | 3 --- docs/content/docs/guides/DEPLOYMENT.md | 3 --- docs/content/docs/guides/DEVICE-INITIAL-SETUP.md | 3 --- docs/content/docs/guides/EXTERNAL-HOST-WALKTHROUGH.md | 3 --- docs/content/docs/guides/GETTING-STARTED.md | 3 --- docs/content/docs/guides/HTTPS-SETUP.md | 3 --- docs/content/docs/guides/IOT-IMPLEMENTATION-GUIDE.md | 3 --- docs/content/docs/guides/MAC-ADDRESS-MAPPING.md | 3 --- docs/content/docs/guides/MIGRATION-GUIDE.md | 3 --- docs/content/docs/guides/MIGRATION-SAFETY.md | 3 --- docs/content/docs/guides/MQTT-INTEGRATION-DESIGN.md | 3 --- docs/content/docs/guides/MUSIC-SERVICES.md | 3 --- docs/content/docs/guides/ON-DEVICE-INSTALL-WALKTHROUGH.md | 3 --- docs/content/docs/guides/RASPBERRY-PI.md | 3 --- docs/content/docs/guides/SELF-HOSTING.md | 3 --- docs/content/docs/guides/SOUNDTOUCH-SERVICE.md | 3 --- docs/content/docs/guides/SURVIVAL-GUIDE.md | 3 --- docs/content/docs/guides/TROUBLESHOOTING.md | 3 --- docs/content/docs/reference/API-COOKBOOK.md | 3 --- docs/content/docs/reference/API-ENDPOINTS.md | 3 --- docs/content/docs/reference/BASS-CONTROLS.md | 3 --- docs/content/docs/reference/CLOUD-API.md | 3 --- docs/content/docs/reference/DEVICE-PAIRING-FLOW.md | 3 --- docs/content/docs/reference/DISCOVERY.md | 3 --- docs/content/docs/reference/FEATURE-MAPPING.md | 3 --- docs/content/docs/reference/KEY-CONTROLS.md | 3 --- docs/content/docs/reference/PRESET-MANAGEMENT.md | 3 --- docs/content/docs/reference/SOURCE-SELECTION.md | 3 --- docs/content/docs/reference/SPEAKER-ENDPOINT.md | 3 --- docs/content/docs/reference/SYSTEM-ENDPOINTS.md | 3 --- docs/content/docs/reference/VOLUME-CONTROLS.md | 3 --- docs/content/docs/reference/WEBSOCKET-EVENTS.md | 3 --- docs/content/docs/reference/ZONE-MANAGEMENT.md | 3 --- docs/content/docs/reference/spotify-account-addition.md | 3 --- 91 files changed, 271 deletions(-) diff --git a/docs/content/docs/analysis/ANONYMIZATION-SUMMARY.md b/docs/content/docs/analysis/ANONYMIZATION-SUMMARY.md index db97e07..d2ed52e 100644 --- a/docs/content/docs/analysis/ANONYMIZATION-SUMMARY.md +++ b/docs/content/docs/analysis/ANONYMIZATION-SUMMARY.md @@ -1,9 +1,6 @@ --- title: "Placeholder values for examples" --- - -# Placeholder values for examples - This repo is public. Documentation, READMEs, example configs, and test fixtures must never carry real LAN IPs, real device MACs, real Bose account IDs, or personal device names from any maintainer or diff --git a/docs/content/docs/analysis/API-COVERAGE.md b/docs/content/docs/analysis/API-COVERAGE.md index ecf5ddf..7a4674e 100644 --- a/docs/content/docs/analysis/API-COVERAGE.md +++ b/docs/content/docs/analysis/API-COVERAGE.md @@ -1,9 +1,6 @@ --- title: "Bose SoundTouch API Coverage Analysis" --- - -# Bose SoundTouch API Coverage Analysis - **Last Updated:** February 2026 **API Version:** Official Bose SoundTouch Web API v1.0 **Implementation Status:** 100% Official Coverage + Extended Features diff --git a/docs/content/docs/analysis/BOSE-APP-ADB-Emulator.md b/docs/content/docs/analysis/BOSE-APP-ADB-Emulator.md index dbdb37e..394f816 100644 --- a/docs/content/docs/analysis/BOSE-APP-ADB-Emulator.md +++ b/docs/content/docs/analysis/BOSE-APP-ADB-Emulator.md @@ -1,9 +1,6 @@ --- title: "Bose SoundTouch Traffic Interception Runbook" --- - -# Bose SoundTouch Traffic Interception Runbook - Intercept HTTPS/WebSocket traffic from the Bose SoundTouch Android app using an Android emulator, mitmproxy, and Frida. Tested on Apple Silicon (ARM64) Mac. ## Automated Setup diff --git a/docs/content/docs/analysis/BOSE-LAB-RUNBOOK.md b/docs/content/docs/analysis/BOSE-LAB-RUNBOOK.md index d40f16b..0e849da 100644 --- a/docs/content/docs/analysis/BOSE-LAB-RUNBOOK.md +++ b/docs/content/docs/analysis/BOSE-LAB-RUNBOOK.md @@ -1,9 +1,6 @@ --- title: "Bose SoundTouch – Traffic Analysis Runbook" --- - -# Bose SoundTouch – Traffic Analysis Runbook - > **Goal:** Set up a Raspberry Pi as a transparent access point to fully observe the traffic of the Bose SoundTouch app – specifically the pairing flow with the Bose Cloud. This serves as a basis for later reverse engineering / simulation of the cloud endpoints. --- diff --git a/docs/content/docs/analysis/DEVICE-REDIRECT-METHODS.md b/docs/content/docs/analysis/DEVICE-REDIRECT-METHODS.md index cc40c0b..1c0a5e7 100644 --- a/docs/content/docs/analysis/DEVICE-REDIRECT-METHODS.md +++ b/docs/content/docs/analysis/DEVICE-REDIRECT-METHODS.md @@ -1,9 +1,6 @@ --- title: "Device Redirect Methods & Custom Service Setup" --- - -# Device Redirect Methods & Custom Service Setup - To enable offline operation or use custom services like **SoundCork** or **ÜberBöse API**, SoundTouch devices must be redirected from Bose's official cloud endpoints to a local or custom server. This document outlines the three known methods to achieve this, gathered from community reverse-engineering efforts in the **SoundCork** and **ÜberBöse API** projects. > A fourth, **SSH-free** path — driving the device's diagnostic shell on TCP port 17000 — is being added as a peer to the XML and DNS methods. See **[TELNET-MIGRATION-METHOD.md](TELNET-MIGRATION-METHOD.md)** for the use cases, community findings, and feasibility analysis. The `/etc/hosts` method documented below is now deprecated and will not be exposed in the web UI. diff --git a/docs/content/docs/analysis/FACTORY-RESET-PROTOCOL.md b/docs/content/docs/analysis/FACTORY-RESET-PROTOCOL.md index 6109a9a..fad3544 100644 --- a/docs/content/docs/analysis/FACTORY-RESET-PROTOCOL.md +++ b/docs/content/docs/analysis/FACTORY-RESET-PROTOCOL.md @@ -1,9 +1,6 @@ --- title: "What a SoundTouch speaker does during factory reset" --- - -# What a SoundTouch speaker does during factory reset - Observed live on ST10 firmware `27.0.6.46330.5043500` (build `epdbuild.trunk.hepdswbld04.2022-08-04`) on 2026-05-12, by running `soundtouch-cli setup factory-reset` and tailing the speaker's `logread` over SSH. The trace is preserved at `_/logs/factory-reset.txt` for reference. ## Sequence diff --git a/docs/content/docs/analysis/IOT-CONFIG-SUMMARY.md b/docs/content/docs/analysis/IOT-CONFIG-SUMMARY.md index 62a14d3..6e8229d 100644 --- a/docs/content/docs/analysis/IOT-CONFIG-SUMMARY.md +++ b/docs/content/docs/analysis/IOT-CONFIG-SUMMARY.md @@ -1,9 +1,6 @@ --- title: "IoT Configuration Quick Reference" --- - -# IoT Configuration Quick Reference - ## Key Files and Locations | File/Location | Purpose | Notes | diff --git a/docs/content/docs/analysis/IOT-CONFIGURATION-ANALYSIS.md b/docs/content/docs/analysis/IOT-CONFIGURATION-ANALYSIS.md index 34c1f34..d637529 100644 --- a/docs/content/docs/analysis/IOT-CONFIGURATION-ANALYSIS.md +++ b/docs/content/docs/analysis/IOT-CONFIGURATION-ANALYSIS.md @@ -1,9 +1,6 @@ --- title: "IoT Configuration Analysis" --- - -# IoT Configuration Analysis - ## Overview This document provides a detailed analysis of the AWS IoT configuration system used by Bose SoundTouch devices, based on firmware backup analysis from ST10 and ST20 models. diff --git a/docs/content/docs/analysis/MISSING-ROUTES-SPOTIFY.md b/docs/content/docs/analysis/MISSING-ROUTES-SPOTIFY.md index 61a0c91..ec4a114 100644 --- a/docs/content/docs/analysis/MISSING-ROUTES-SPOTIFY.md +++ b/docs/content/docs/analysis/MISSING-ROUTES-SPOTIFY.md @@ -1,9 +1,6 @@ --- title: "Spotify Account Addition Implementation Status" --- - -# Spotify Account Addition Implementation Status - To fully replace Bose cloud services for the Spotify account addition flow in the "Stockholm" SoundTouch application, the following routes have been implemented in the `soundtouch-service`: ## 1. OAuth Token Exchange (Bose Cloud) diff --git a/docs/content/docs/analysis/SETUP-WEBSOCKET-EXPERIMENT.md b/docs/content/docs/analysis/SETUP-WEBSOCKET-EXPERIMENT.md index dc533cc..9c51517 100644 --- a/docs/content/docs/analysis/SETUP-WEBSOCKET-EXPERIMENT.md +++ b/docs/content/docs/analysis/SETUP-WEBSOCKET-EXPERIMENT.md @@ -1,9 +1,6 @@ --- title: "Experiment: Does bare `setMargeAccount` work outside the SETUP bracket?" --- - -# Experiment: Does bare `setMargeAccount` work outside the SETUP bracket? - ## Why we are doing this Our captured pairing flow (`docs/reference/DEVICE-PAIRING-FLOW.md`) shows the official Bose app always sends `setMargeAccount` *inside* a `SETUP_START` → `SETUP_ENTER` → `SETUP_LEAVE` state-machine bracket over WebSocket. The question this experiment answers: diff --git a/docs/content/docs/analysis/SUPPORTED-URLS.md b/docs/content/docs/analysis/SUPPORTED-URLS.md index c207d2b..4e23c56 100644 --- a/docs/content/docs/analysis/SUPPORTED-URLS.md +++ b/docs/content/docs/analysis/SUPPORTED-URLS.md @@ -1,9 +1,6 @@ --- title: "SoundTouch supportedURLs Endpoint Analysis" --- - -# SoundTouch supportedURLs Endpoint Analysis - This document provides a comprehensive analysis of the `/supportedURLs` endpoint response from real Bose SoundTouch devices and compares it with our current implementation. ## Discovery Summary diff --git a/docs/content/docs/analysis/TELNET-COMMAND-REFERENCE.md b/docs/content/docs/analysis/TELNET-COMMAND-REFERENCE.md index b0d7bfd..350b95d 100644 --- a/docs/content/docs/analysis/TELNET-COMMAND-REFERENCE.md +++ b/docs/content/docs/analysis/TELNET-COMMAND-REFERENCE.md @@ -1,9 +1,6 @@ --- title: "Bose SoundTouch Telnet (Port 17000) Command Reference" --- - -# Bose SoundTouch Telnet (Port 17000) Command Reference - A consolidated reference for the diagnostic shell that listens on TCP port 17000 across the SoundTouch line. Compiled from multiple community sources to give a single map of what's been observed in the wild — useful both for diff --git a/docs/content/docs/analysis/TELNET-MIGRATION-METHOD.md b/docs/content/docs/analysis/TELNET-MIGRATION-METHOD.md index b3c10f8..c936a07 100644 --- a/docs/content/docs/analysis/TELNET-MIGRATION-METHOD.md +++ b/docs/content/docs/analysis/TELNET-MIGRATION-METHOD.md @@ -1,9 +1,6 @@ --- title: "Telnet (Port 17000) Migration Method — Analysis" --- - -# Telnet (Port 17000) Migration Method — Analysis - This document captures the use cases, community findings, and feasibility analysis for adding a **Telnet/port 17000** migration path to `soundtouch-service` as a peer of the existing XML and DNS-based methods. The `/etc/hosts` method stays diff --git a/docs/content/docs/analysis/UPSTREAM-URLS.md b/docs/content/docs/analysis/UPSTREAM-URLS.md index c1e47d8..01a65a3 100644 --- a/docs/content/docs/analysis/UPSTREAM-URLS.md +++ b/docs/content/docs/analysis/UPSTREAM-URLS.md @@ -1,9 +1,6 @@ --- title: "Upstream URLs & Domains Analysis" --- - -# Upstream URLs & Domains Analysis - This document provides a comprehensive overview of the upstream Bose cloud services and domains that SoundTouch devices communicate with. These details were gathered from firmware analysis of ST10/ST20 devices, binary string extraction, and community research from the **SoundCork** project (Issue #128). ## Core Service Domains diff --git a/docs/content/docs/analysis/WIKI-COMPARISON.md b/docs/content/docs/analysis/WIKI-COMPARISON.md index 7f602ac..9e474bc 100644 --- a/docs/content/docs/analysis/WIKI-COMPARISON.md +++ b/docs/content/docs/analysis/WIKI-COMPARISON.md @@ -1,9 +1,6 @@ --- title: "SoundTouch API Comparison: Community Wiki vs Current Implementation" --- - -# SoundTouch API Comparison: Community Wiki vs Current Implementation - **Date:** January 2026 **Source:** [SoundTouch Plus Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API) **Our Implementation:** Bose-SoundTouch Go Library v1.0 diff --git a/docs/content/docs/analysis/bose-soundtouch-community-tools.md b/docs/content/docs/analysis/bose-soundtouch-community-tools.md index af5b82c..116bd42 100644 --- a/docs/content/docs/analysis/bose-soundtouch-community-tools.md +++ b/docs/content/docs/analysis/bose-soundtouch-community-tools.md @@ -1,9 +1,6 @@ --- title: "Bose SoundTouch — Community Tools for Post-EOL Preservation" --- - -# Bose SoundTouch — Community Tools for Post-EOL Preservation - > **Context:** Bose announced the shutdown of SoundTouch cloud services, extended to **May 6, 2026**. On that date the official SoundTouch app will update to a local-only version. Bose has released the [SoundTouch Web API documentation](https://assets.bosecreative.com/m/496577402d128874/original/SoundTouch-Web-API.pdf) as open-source to enable community-driven development. This document surveys the active community projects, their feature coverage, and open development opportunities. --- diff --git a/docs/content/docs/appendix/API-NAVIGATION-REFERENCE.md b/docs/content/docs/appendix/API-NAVIGATION-REFERENCE.md index 18776b4..4d3f429 100644 --- a/docs/content/docs/appendix/API-NAVIGATION-REFERENCE.md +++ b/docs/content/docs/appendix/API-NAVIGATION-REFERENCE.md @@ -3,9 +3,6 @@ title: "Navigation API Reference" sidebar: exclude: true --- - -# Navigation API Reference - ## Overview This document provides a complete API reference for the Bose SoundTouch navigation and station management functionality. For usage examples and workflows, see [NAVIGATION-GUIDE.md](NAVIGATION-GUIDE.md). diff --git a/docs/content/docs/appendix/CLAUDE.md b/docs/content/docs/appendix/CLAUDE.md index 1926c4a..28b03d8 100644 --- a/docs/content/docs/appendix/CLAUDE.md +++ b/docs/content/docs/appendix/CLAUDE.md @@ -3,9 +3,6 @@ title: "CLAUDE.md - Development Guidelines for Bose SoundTouch Project" sidebar: exclude: true --- - -# CLAUDE.md - Development Guidelines for Bose SoundTouch Project - ## Documentation Overview This document contains important development guidelines for working on the Bose SoundTouch project. Please also read the following documentation: diff --git a/docs/content/docs/appendix/CONTENT-SELECTION-IMPLEMENTATION.md b/docs/content/docs/appendix/CONTENT-SELECTION-IMPLEMENTATION.md index 09b5759..21ad670 100644 --- a/docs/content/docs/appendix/CONTENT-SELECTION-IMPLEMENTATION.md +++ b/docs/content/docs/appendix/CONTENT-SELECTION-IMPLEMENTATION.md @@ -3,9 +3,6 @@ title: "Content Selection Implementation Summary" sidebar: exclude: true --- - -# Content Selection Implementation Summary - This document summarizes the implementation of advanced content selection features for the Bose SoundTouch Go client, including full support for the LOCAL_INTERNET_RADIO streamUrl format and LOCAL_MUSIC/STORED_MUSIC content selection. ## ✅ Implementation Status: COMPLETE diff --git a/docs/content/docs/appendix/DEVICE-CUSTOMIZATION-SETUP.md b/docs/content/docs/appendix/DEVICE-CUSTOMIZATION-SETUP.md index e6b36ad..aa9432b 100644 --- a/docs/content/docs/appendix/DEVICE-CUSTOMIZATION-SETUP.md +++ b/docs/content/docs/appendix/DEVICE-CUSTOMIZATION-SETUP.md @@ -3,9 +3,6 @@ title: "Device Customization Setup Guide" sidebar: exclude: true --- - -# Device Customization Setup Guide - This guide documents the manual steps required to configure your Bose SoundTouch device for customization using the SoundCork approach. Based on: https://github.com/deborahgu/soundcork diff --git a/docs/content/docs/appendix/DEVICE-LOGGING.md b/docs/content/docs/appendix/DEVICE-LOGGING.md index a485b20..5b0b743 100644 --- a/docs/content/docs/appendix/DEVICE-LOGGING.md +++ b/docs/content/docs/appendix/DEVICE-LOGGING.md @@ -3,9 +3,6 @@ title: "Device Logging & Troubleshooting" sidebar: exclude: true --- - -# Device Logging & Troubleshooting - Accessing logs from SoundTouch devices is critical for debugging custom service integrations and understanding internal device behavior. This document outlines the methods for collecting logs, as discovered by the **SoundCork** and **ÜberBöse API** communities. ## Log Types diff --git a/docs/content/docs/appendix/DEVICE-SETUP.md b/docs/content/docs/appendix/DEVICE-SETUP.md index 9188d1c..d162f50 100644 --- a/docs/content/docs/appendix/DEVICE-SETUP.md +++ b/docs/content/docs/appendix/DEVICE-SETUP.md @@ -3,9 +3,6 @@ title: "Bose SoundTouch Device Setup Flow" sidebar: exclude: true --- - -# Bose SoundTouch Device Setup Flow - This document details the multi-step process required to fully set up a Bose SoundTouch device, as derived from the Stockholm firmware (`setup/js/`) analysis. A complete setup flow involves a sequence of local (WebSocket) and cloud (HTTP) actions that move the device from a factory-reset state to a fully registered, functional system. diff --git a/docs/content/docs/appendix/DIAGNOSTIC-EXPORT.md b/docs/content/docs/appendix/DIAGNOSTIC-EXPORT.md index dc703e8..1623691 100644 --- a/docs/content/docs/appendix/DIAGNOSTIC-EXPORT.md +++ b/docs/content/docs/appendix/DIAGNOSTIC-EXPORT.md @@ -3,9 +3,6 @@ title: "Encrypted Diagnostic Export" sidebar: exclude: true --- - -# Encrypted Diagnostic Export - AfterTouch can produce an encrypted diagnostic report that users can download and send to the project maintainer without exposing sensitive data to third parties. The report is encrypted with an SSH public key using diff --git a/docs/content/docs/appendix/EXTERNAL-SERVICES-ABSTRACTION.md b/docs/content/docs/appendix/EXTERNAL-SERVICES-ABSTRACTION.md index 516e9d4..08ac9b9 100644 --- a/docs/content/docs/appendix/EXTERNAL-SERVICES-ABSTRACTION.md +++ b/docs/content/docs/appendix/EXTERNAL-SERVICES-ABSTRACTION.md @@ -3,9 +3,6 @@ title: "Technical Proposal: External Service Provider Abstraction" sidebar: exclude: true --- - -# Technical Proposal: External Service Provider Abstraction - This document outlines a strategy to refactor the SoundTouch Service's content handling into a modular provider-based system. ## 1. Problem Statement diff --git a/docs/content/docs/appendix/FEATURE_HISTORY.md b/docs/content/docs/appendix/FEATURE_HISTORY.md index 7717fb4..5680ef2 100644 --- a/docs/content/docs/appendix/FEATURE_HISTORY.md +++ b/docs/content/docs/appendix/FEATURE_HISTORY.md @@ -3,9 +3,6 @@ title: "Feature Development History" sidebar: exclude: true --- - -# Feature Development History - This document tracks the detailed evolution of features and capabilities in the Bose SoundTouch API client library. ## Development Timeline diff --git a/docs/content/docs/appendix/HOST-PORT-PARSING.md b/docs/content/docs/appendix/HOST-PORT-PARSING.md index e3d2738..158712f 100644 --- a/docs/content/docs/appendix/HOST-PORT-PARSING.md +++ b/docs/content/docs/appendix/HOST-PORT-PARSING.md @@ -3,9 +3,6 @@ title: "Host:Port Parsing Feature" sidebar: exclude: true --- - -# Host:Port Parsing Feature - This document describes the automatic host:port parsing functionality added to the SoundTouch CLI, which allows users to specify both host and port in a single `-host` flag. ## Overview diff --git a/docs/content/docs/appendix/MANUAL-NETWORK-DISCOVERY.md b/docs/content/docs/appendix/MANUAL-NETWORK-DISCOVERY.md index a4cf78c..ca4af14 100644 --- a/docs/content/docs/appendix/MANUAL-NETWORK-DISCOVERY.md +++ b/docs/content/docs/appendix/MANUAL-NETWORK-DISCOVERY.md @@ -3,9 +3,6 @@ title: "Manual Network Discovery on macOS" sidebar: exclude: true --- - -# Manual Network Discovery on macOS - This document provides comprehensive guidance for manually discovering network services and devices using built-in macOS tools and command-line utilities. This is particularly useful for troubleshooting network discovery issues or understanding what services are available on your local network. ## Overview diff --git a/docs/content/docs/appendix/NAVIGATION-GUIDE.md b/docs/content/docs/appendix/NAVIGATION-GUIDE.md index 7f19744..a00efcf 100644 --- a/docs/content/docs/appendix/NAVIGATION-GUIDE.md +++ b/docs/content/docs/appendix/NAVIGATION-GUIDE.md @@ -3,9 +3,6 @@ title: "Navigation and Station Management Guide" sidebar: exclude: true --- - -# Navigation and Station Management Guide - ## Overview The Bose SoundTouch Go client provides comprehensive navigation and station management functionality that allows you to: diff --git a/docs/content/docs/appendix/OFFICIAL-API-VERIFICATION.md b/docs/content/docs/appendix/OFFICIAL-API-VERIFICATION.md index d5c4fb8..e88d645 100644 --- a/docs/content/docs/appendix/OFFICIAL-API-VERIFICATION.md +++ b/docs/content/docs/appendix/OFFICIAL-API-VERIFICATION.md @@ -3,9 +3,6 @@ title: "Official SoundTouch Web API Verification" sidebar: exclude: true --- - -# Official SoundTouch Web API Verification - **Source**: Official Bose SoundTouch Web API v1.0 Documentation (January 7, 2026) **Verification Date**: January 9, 2026 **Project Status**: Complete API coverage verification diff --git a/docs/content/docs/appendix/PARITY-OPENCLOUDTOUCH.md b/docs/content/docs/appendix/PARITY-OPENCLOUDTOUCH.md index 688e96b..202808d 100644 --- a/docs/content/docs/appendix/PARITY-OPENCLOUDTOUCH.md +++ b/docs/content/docs/appendix/PARITY-OPENCLOUDTOUCH.md @@ -3,9 +3,6 @@ title: "Parity Analysis: Bose-SoundTouch (Go) vs. OpenCloudTouch (Python)" sidebar: exclude: true --- - -# Parity Analysis: Bose-SoundTouch (Go) vs. OpenCloudTouch (Python) - This document provides a comparative analysis of the current Go implementation and the `scheilch/opencloudtouch` project, identifying functional gaps and potential improvements. ## 1. Core Architecture and Language diff --git a/docs/content/docs/appendix/PARITY-SOUNDCORK.md b/docs/content/docs/appendix/PARITY-SOUNDCORK.md index 7c85afc..97dbbf1 100644 --- a/docs/content/docs/appendix/PARITY-SOUNDCORK.md +++ b/docs/content/docs/appendix/PARITY-SOUNDCORK.md @@ -3,9 +3,6 @@ title: "Parity Analysis: Bose-SoundTouch (Go) vs. SoundCork (Python)" sidebar: exclude: true --- - -# Parity Analysis: Bose-SoundTouch (Go) vs. SoundCork (Python) - This document provides a comparative analysis of the current Go implementation and the `deborahgu/soundcork` project, identifying functional gaps and potential improvements. ## 1. Core Architecture and Language diff --git a/docs/content/docs/appendix/PRESET-QUICKSTART.md b/docs/content/docs/appendix/PRESET-QUICKSTART.md index e100b0b..9214c70 100644 --- a/docs/content/docs/appendix/PRESET-QUICKSTART.md +++ b/docs/content/docs/appendix/PRESET-QUICKSTART.md @@ -3,9 +3,6 @@ title: "Preset Management Quick Start Guide" sidebar: exclude: true --- - -# Preset Management Quick Start Guide - **Save your favorite music, radio stations, and playlists as 1-6 presets for instant access.** ## Overview diff --git a/docs/content/docs/appendix/PROJECT-PATTERNS.md b/docs/content/docs/appendix/PROJECT-PATTERNS.md index 1b45d2e..aae872c 100644 --- a/docs/content/docs/appendix/PROJECT-PATTERNS.md +++ b/docs/content/docs/appendix/PROJECT-PATTERNS.md @@ -3,8 +3,6 @@ title: "Project Structure Patterns: Bose SoundTouch API Client" sidebar: exclude: true --- - -# Project Structure Patterns: Bose SoundTouch API Client ## Summary for Reuse in API Client Projects This document describes the most important patterns for the Bose SoundTouch API client, especially for XML-based API clients with Web UI, CLI tool, and WASM support. diff --git a/docs/content/docs/appendix/REQUEST_RECORDING_CONCEPT.md b/docs/content/docs/appendix/REQUEST_RECORDING_CONCEPT.md index b8e4ffe..eddd6d8 100644 --- a/docs/content/docs/appendix/REQUEST_RECORDING_CONCEPT.md +++ b/docs/content/docs/appendix/REQUEST_RECORDING_CONCEPT.md @@ -3,9 +3,6 @@ title: "Request Recording Concept" sidebar: exclude: true --- - -# Request Recording Concept - ## Problem Statement The current request recording system has fundamental issues when dealing with request cloning, body consumption, and multiple response scenarios. Specifically: diff --git a/docs/content/docs/appendix/SCMUDC-ENRICHMENT-IMPLEMENTATION.md b/docs/content/docs/appendix/SCMUDC-ENRICHMENT-IMPLEMENTATION.md index 4544f1b..22fe554 100644 --- a/docs/content/docs/appendix/SCMUDC-ENRICHMENT-IMPLEMENTATION.md +++ b/docs/content/docs/appendix/SCMUDC-ENRICHMENT-IMPLEMENTATION.md @@ -3,9 +3,6 @@ title: "SCMUDC Enrichment Implementation Summary" sidebar: exclude: true --- - -# SCMUDC Enrichment Implementation Summary - ## Overview This document summarizes the implementation of SCMUDC (Sound Control Management Usage Data Collection) event enrichment in the AfterTouch toolkit. The enhancement provides human-readable analysis of device telemetry data to improve usability and debugging capabilities. diff --git a/docs/content/docs/appendix/SERVICE-AVAILABILITY-IMPLEMENTATION.md b/docs/content/docs/appendix/SERVICE-AVAILABILITY-IMPLEMENTATION.md index 8320409..3e427d7 100644 --- a/docs/content/docs/appendix/SERVICE-AVAILABILITY-IMPLEMENTATION.md +++ b/docs/content/docs/appendix/SERVICE-AVAILABILITY-IMPLEMENTATION.md @@ -3,9 +3,6 @@ title: "Service Availability Implementation Summary" sidebar: exclude: true --- - -# Service Availability Implementation Summary - ## Overview This document summarizes the implementation of the `/serviceAvailability` endpoint support in the Bose SoundTouch Go client library. This feature enables applications to query which music services and input sources are available on a SoundTouch device, providing better user feedback about supported stations and sources. diff --git a/docs/content/docs/appendix/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md b/docs/content/docs/appendix/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md index 9e32573..72f0752 100644 --- a/docs/content/docs/appendix/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md +++ b/docs/content/docs/appendix/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md @@ -3,9 +3,6 @@ title: "🎉 Introducing SoundTouch Service: Local Cloud Service Emulation" sidebar: exclude: true --- - -# 🎉 Introducing SoundTouch Service: Local Cloud Service Emulation - **Date**: February 2026 **Version**: v2.0.0+ **Status**: Production Ready diff --git a/docs/content/docs/appendix/UNDOCUMENTED-COMMUNITY-FEATURES.md b/docs/content/docs/appendix/UNDOCUMENTED-COMMUNITY-FEATURES.md index e9a5a5a..702471c 100644 --- a/docs/content/docs/appendix/UNDOCUMENTED-COMMUNITY-FEATURES.md +++ b/docs/content/docs/appendix/UNDOCUMENTED-COMMUNITY-FEATURES.md @@ -3,8 +3,6 @@ title: "Undocumented Community Features & API Discoveries" sidebar: exclude: true --- - -# Undocumented Community Features & API Discoveries This document captures advanced API endpoints and device behaviors discovered by the SoundTouch community through reverse engineering projects like **SoundCork** and **ÜberBöse API**. These features are not documented in the official Bose SoundTouch Web API v1.0 but are crucial for full device emulation and offline operation. ## Cloud Emulation (Marge/BMX) Discoveries While the local `/8090` API is well-documented, the cloud-side service emulation reveals deeper device integration points. diff --git a/docs/content/docs/appendix/UNIMPLEMENTED-ENDPOINTS.md b/docs/content/docs/appendix/UNIMPLEMENTED-ENDPOINTS.md index 3b9bbfb..847e1ff 100644 --- a/docs/content/docs/appendix/UNIMPLEMENTED-ENDPOINTS.md +++ b/docs/content/docs/appendix/UNIMPLEMENTED-ENDPOINTS.md @@ -3,9 +3,6 @@ title: "Unimplemented SoundTouch API Endpoints" sidebar: exclude: true --- - -# Unimplemented SoundTouch API Endpoints - **Last Updated:** January 2026 **Source:** [SoundTouch Plus Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API) **Current Implementation:** 35 endpoints (including preset & navigation management discovered via SoundTouch Plus Wiki) diff --git a/docs/content/docs/appendix/device-lifecycle-and-power-on-enhancement.md b/docs/content/docs/appendix/device-lifecycle-and-power-on-enhancement.md index 8a543cf..a0def55 100644 --- a/docs/content/docs/appendix/device-lifecycle-and-power-on-enhancement.md +++ b/docs/content/docs/appendix/device-lifecycle-and-power-on-enhancement.md @@ -3,9 +3,6 @@ title: "Device Lifecycle and /power_on Enhancement" sidebar: exclude: true --- - -# Device Lifecycle and /power_on Enhancement - ## Overview This document provides a comprehensive analysis of the current SoundTouch device registration and lifecycle management implementation, and proposes enhancements using the `/power_on` endpoint to reduce dependency on local network connectivity. diff --git a/docs/content/docs/appendix/device-lifecycle-summary.md b/docs/content/docs/appendix/device-lifecycle-summary.md index 4172215..5a859e1 100644 --- a/docs/content/docs/appendix/device-lifecycle-summary.md +++ b/docs/content/docs/appendix/device-lifecycle-summary.md @@ -3,9 +3,6 @@ title: "Device Lifecycle Analysis - Executive Summary" sidebar: exclude: true --- - -# Device Lifecycle Analysis - Executive Summary - ## Current State Assessment The SoundTouch service currently relies heavily on local network connectivity for device discovery and management: diff --git a/docs/content/docs/appendix/power-on-implementation-guide.md b/docs/content/docs/appendix/power-on-implementation-guide.md index 389e4f8..a817a68 100644 --- a/docs/content/docs/appendix/power-on-implementation-guide.md +++ b/docs/content/docs/appendix/power-on-implementation-guide.md @@ -3,9 +3,6 @@ title: "/power_on Implementation Guide" sidebar: exclude: true --- - -# /power_on Implementation Guide - ## Overview This guide provides detailed technical specifications for implementing `/power_on` endpoint enhancements to reduce network dependency and improve device lifecycle management in the SoundTouch service. diff --git a/docs/content/docs/appendix/preset-store.md b/docs/content/docs/appendix/preset-store.md index ad2b85a..70d191b 100644 --- a/docs/content/docs/appendix/preset-store.md +++ b/docs/content/docs/appendix/preset-store.md @@ -3,9 +3,6 @@ title: "SoundTouch `/storePreset` Implementation Guide" sidebar: exclude: true --- - -# SoundTouch `/storePreset` Implementation Guide - ## Overview This document analyzes the feasibility and implementation approach for adding `/storePreset` functionality to the Bose SoundTouch API client, based on [GitHub Issue #14](https://github.com/gesellix/Bose-SoundTouch/issues/14) and endpoints discovered through the comprehensive [SoundTouch Plus Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API). diff --git a/docs/content/docs/appendix/scmudc-events-analysis.md b/docs/content/docs/appendix/scmudc-events-analysis.md index 298a3b8..fa2d9c5 100644 --- a/docs/content/docs/appendix/scmudc-events-analysis.md +++ b/docs/content/docs/appendix/scmudc-events-analysis.md @@ -3,9 +3,6 @@ title: "SCMUDC Events Analysis" sidebar: exclude: true --- - -# SCMUDC Events Analysis - ## Overview SCMUDC (Sound Control Management Usage Data Collection) events are telemetry data sent from SoundTouch devices to `events.api.bosecm.com` via `/v1/scmudc/{deviceId}` endpoints. These events track user interactions and device behaviors for analytics and monitoring. diff --git a/docs/content/docs/appendix/soundtouch-web-roadmap.md b/docs/content/docs/appendix/soundtouch-web-roadmap.md index c3a56d0..5ec4d47 100644 --- a/docs/content/docs/appendix/soundtouch-web-roadmap.md +++ b/docs/content/docs/appendix/soundtouch-web-roadmap.md @@ -3,9 +3,6 @@ title: "soundtouch-web: remaining features" sidebar: exclude: true --- - -# soundtouch-web: remaining features - Four features complete the parity gap between soundtouch-web and the Stockholm app's local-control functionality. Everything else in Stockholm (OAuth flows, setup wizard, service account linking, onboarding, analytics) is cloud diff --git a/docs/content/docs/appendix/stockholm-port-guide.md b/docs/content/docs/appendix/stockholm-port-guide.md index fc74189..c96dcd7 100644 --- a/docs/content/docs/appendix/stockholm-port-guide.md +++ b/docs/content/docs/appendix/stockholm-port-guide.md @@ -3,9 +3,6 @@ title: "Stockholm Backend — Port Guide for Bose-SoundTouch (Go)" sidebar: exclude: true --- - -# Stockholm Backend — Port Guide for Bose-SoundTouch (Go) - This document describes everything needed to integrate the [krahl/soundcork-stockholm-app](https://github.com/krahl/soundcork-stockholm-app) functionality into the Go service. It is written as a reference; nothing here diff --git a/docs/content/docs/architecture/DEVICE-LOCAL-INSTALL.md b/docs/content/docs/architecture/DEVICE-LOCAL-INSTALL.md index 16ac3da..88d1c9f 100644 --- a/docs/content/docs/architecture/DEVICE-LOCAL-INSTALL.md +++ b/docs/content/docs/architecture/DEVICE-LOCAL-INSTALL.md @@ -1,9 +1,6 @@ --- title: "Device-Local Install: Four User Journeys" --- - -# Device-Local Install: Four User Journeys - > **Looking for how to actually install AfterTouch?** > See the [Deployment Overview](../guides/DEPLOYMENT-OVERVIEW.md) for user-friendly > step-by-step guides for both deployment scenarios (external host and on-device). diff --git a/docs/content/docs/concepts/ENCRYPTED-EXPORT.md b/docs/content/docs/concepts/ENCRYPTED-EXPORT.md index dc8cb89..f2068d5 100644 --- a/docs/content/docs/concepts/ENCRYPTED-EXPORT.md +++ b/docs/content/docs/concepts/ENCRYPTED-EXPORT.md @@ -1,9 +1,6 @@ --- title: "Encrypting Sensitive Data Exports with SSH/age or GPG" --- - -# Encrypting Sensitive Data Exports with SSH/age or GPG - ## Problem Allow users of our software to export potentially sensitive data, encrypt it locally, and send it to us. We decrypt on our side. Goal: no key exchange, minimal user friction. diff --git a/docs/content/docs/concepts/amazon-music-oauth.md b/docs/content/docs/concepts/amazon-music-oauth.md index f638148..d3888be 100644 --- a/docs/content/docs/concepts/amazon-music-oauth.md +++ b/docs/content/docs/concepts/amazon-music-oauth.md @@ -1,9 +1,6 @@ --- title: "Amazon Music OAuth Integration" --- - -# Amazon Music OAuth Integration - This document describes the plan and specification for adding Amazon Music OAuth support to the SoundTouch service, enabling continued Amazon Music playback after the Bose cloud shutdown (May 2026). The implementation mirrors the [Spotify OAuth integration](spotify-oauth.md) closely. Read that document first — this one calls out only the differences. diff --git a/docs/content/docs/concepts/spotify-oauth.md b/docs/content/docs/concepts/spotify-oauth.md index 693ac91..8abba9a 100644 --- a/docs/content/docs/concepts/spotify-oauth.md +++ b/docs/content/docs/concepts/spotify-oauth.md @@ -1,9 +1,6 @@ --- title: "Spotify OAuth Integration" --- - -# Spotify OAuth Integration - > **New here?** Start with [spotify-overview.md](spotify-overview.md) for the > mental model (Spotify Connect vs OAuth-intercept, DNS rewrite gotcha, > end-to-end token lifecycle). This document zooms in on the OAuth flows and diff --git a/docs/content/docs/concepts/spotify-overview.md b/docs/content/docs/concepts/spotify-overview.md index 443499a..87301e7 100644 --- a/docs/content/docs/concepts/spotify-overview.md +++ b/docs/content/docs/concepts/spotify-overview.md @@ -1,9 +1,6 @@ --- title: "Spotify on SoundTouch — Overview" --- - -# Spotify on SoundTouch — Overview - This is the entry point for understanding how Spotify works on a SoundTouch speaker behind AfterTouch. Read this first; the deeper docs assume you already have the mental model below. diff --git a/docs/content/docs/concepts/spotify-priming-strategy.md b/docs/content/docs/concepts/spotify-priming-strategy.md index 824d9e3..87d1f5b 100644 --- a/docs/content/docs/concepts/spotify-priming-strategy.md +++ b/docs/content/docs/concepts/spotify-priming-strategy.md @@ -1,9 +1,6 @@ --- title: "Spotify Priming Strategy" --- - -# Spotify Priming Strategy - > **New here?** Start with [spotify-overview.md](spotify-overview.md) for the > mental model. This document goes deep on the priming protocol, ZeroConf DH > exchange, and deployment topologies. diff --git a/docs/content/docs/diagrams/migration-flow.md b/docs/content/docs/diagrams/migration-flow.md index 93f56b1..2bfa18b 100644 --- a/docs/content/docs/diagrams/migration-flow.md +++ b/docs/content/docs/diagrams/migration-flow.md @@ -1,9 +1,6 @@ --- title: "Migration Flow Diagrams" --- - -# Migration Flow Diagrams - This document specifies the diagrams needed for the migration guide, with descriptions that can be used to create actual visual diagrams. ## 1. Overall Migration Process Flow diff --git a/docs/content/docs/guides/CAPTURE-DEVICE-PAIRING.md b/docs/content/docs/guides/CAPTURE-DEVICE-PAIRING.md index 6c0674f..3192473 100644 --- a/docs/content/docs/guides/CAPTURE-DEVICE-PAIRING.md +++ b/docs/content/docs/guides/CAPTURE-DEVICE-PAIRING.md @@ -1,9 +1,6 @@ --- title: "Capture Device Pairing Traffic" --- - -# Capture Device Pairing Traffic - Step-by-step runbook for factory-resetting a SoundTouch speaker, pairing it to a Bose cloud account, and capturing every cloud request via mitmproxy. Tested on Apple Silicon Mac. **Goal:** obtain a full `.mitm` recording of the account-pairing flow (streaming.bose.com) triggered by the official Android app. diff --git a/docs/content/docs/guides/CAPTURE-MIGRATION-TRAFFIC.md b/docs/content/docs/guides/CAPTURE-MIGRATION-TRAFFIC.md index 43d3698..a71f4fe 100644 --- a/docs/content/docs/guides/CAPTURE-MIGRATION-TRAFFIC.md +++ b/docs/content/docs/guides/CAPTURE-MIGRATION-TRAFFIC.md @@ -1,9 +1,6 @@ --- title: "Capture Speaker Migration Traffic" --- - -# Capture Speaker Migration Traffic - Runbook for migrating a SoundTouch speaker to `soundtouch-service` and capturing all traffic (App→Service and Speaker→Service) to identify unimplemented endpoints. diff --git a/docs/content/docs/guides/CLI-REFERENCE.md b/docs/content/docs/guides/CLI-REFERENCE.md index a079b76..8b3d99c 100644 --- a/docs/content/docs/guides/CLI-REFERENCE.md +++ b/docs/content/docs/guides/CLI-REFERENCE.md @@ -1,9 +1,6 @@ --- title: "SoundTouch CLI Reference" --- - -# SoundTouch CLI Reference - **Complete command reference for the soundtouch-cli tool** This document provides comprehensive documentation for all available commands and options in the `soundtouch-cli` tool. diff --git a/docs/content/docs/guides/CLOUD-DEPLOY-WALKTHROUGH.md b/docs/content/docs/guides/CLOUD-DEPLOY-WALKTHROUGH.md index 0e77180..613fa8b 100644 --- a/docs/content/docs/guides/CLOUD-DEPLOY-WALKTHROUGH.md +++ b/docs/content/docs/guides/CLOUD-DEPLOY-WALKTHROUGH.md @@ -1,9 +1,6 @@ --- title: "Cloud Deployment Walkthrough" --- - -# Cloud Deployment Walkthrough - A step-by-step guide to running AfterTouch on a VPS or cloud server and pointing your local Bose SoundTouch speakers at it. diff --git a/docs/content/docs/guides/DEPLOYMENT-OVERVIEW.md b/docs/content/docs/guides/DEPLOYMENT-OVERVIEW.md index 9d75c3c..695e23f 100644 --- a/docs/content/docs/guides/DEPLOYMENT-OVERVIEW.md +++ b/docs/content/docs/guides/DEPLOYMENT-OVERVIEW.md @@ -1,9 +1,6 @@ --- title: "AfterTouch Deployment Overview" --- - -# AfterTouch Deployment Overview - AfterTouch replaces the Bose SoundTouch cloud, which shut down on 2026-05-06. There are three ways to run it — pick the one that fits your situation. diff --git a/docs/content/docs/guides/DEPLOYMENT.md b/docs/content/docs/guides/DEPLOYMENT.md index 5bc75e6..09d7592 100644 --- a/docs/content/docs/guides/DEPLOYMENT.md +++ b/docs/content/docs/guides/DEPLOYMENT.md @@ -1,9 +1,6 @@ --- title: "SoundTouch Production Deployment Guide" --- - -# SoundTouch Production Deployment Guide - **Best practices for deploying SoundTouch Go applications in production environments** This guide covers everything you need to know to deploy robust, scalable SoundTouch applications in production, including configuration management, monitoring, security, and operational considerations. diff --git a/docs/content/docs/guides/DEVICE-INITIAL-SETUP.md b/docs/content/docs/guides/DEVICE-INITIAL-SETUP.md index 52c3f94..57adc43 100644 --- a/docs/content/docs/guides/DEVICE-INITIAL-SETUP.md +++ b/docs/content/docs/guides/DEVICE-INITIAL-SETUP.md @@ -1,9 +1,6 @@ --- title: "SoundTouch Device Initial Setup Variants" --- - -# SoundTouch Device Initial Setup Variants - Based on community research from the **SoundCork** and **ÜberBöse API** projects, as well as analysis of the Stockholm firmware (`firmware/Stockholm/.../setup/`), this document outlines the methods used for the "out-of-the-box" setup of SoundTouch devices. ## Setup Overview diff --git a/docs/content/docs/guides/EXTERNAL-HOST-WALKTHROUGH.md b/docs/content/docs/guides/EXTERNAL-HOST-WALKTHROUGH.md index 989d497..bcab358 100644 --- a/docs/content/docs/guides/EXTERNAL-HOST-WALKTHROUGH.md +++ b/docs/content/docs/guides/EXTERNAL-HOST-WALKTHROUGH.md @@ -1,9 +1,6 @@ --- title: "External Host Walkthrough" --- - -# External Host Walkthrough - A step-by-step guide to running AfterTouch on a Raspberry Pi (or any always-on computer) and migrating your Bose SoundTouch speakers to use it. diff --git a/docs/content/docs/guides/GETTING-STARTED.md b/docs/content/docs/guides/GETTING-STARTED.md index 13291d1..0da7d03 100644 --- a/docs/content/docs/guides/GETTING-STARTED.md +++ b/docs/content/docs/guides/GETTING-STARTED.md @@ -1,9 +1,6 @@ --- title: "Getting Started with SoundTouch Go Client" --- - -# Getting Started with SoundTouch Go Client - **A complete guide to controlling your Bose SoundTouch devices with Go** This guide will get you up and running with the SoundTouch Go client in under 10 minutes. By the end, you'll be able to discover devices, control playback, manage volume, and monitor real-time events. diff --git a/docs/content/docs/guides/HTTPS-SETUP.md b/docs/content/docs/guides/HTTPS-SETUP.md index 2c0ea9e..8bcd151 100644 --- a/docs/content/docs/guides/HTTPS-SETUP.md +++ b/docs/content/docs/guides/HTTPS-SETUP.md @@ -1,9 +1,6 @@ --- title: "HTTPS & Custom CA Certificate" --- - -# HTTPS & Custom CA Certificate - SoundTouch speakers communicate with cloud services over HTTPS. For the local service to work over HTTPS, speakers must trust the AfterTouch Root CA. The service manages this automatically — it generates a CA on first start and the web UI guides you through installing it on each speaker as part of the migration flow. > ### ⚠️ Speakers connect to `:443`, AfterTouch defaults to `:8443` diff --git a/docs/content/docs/guides/IOT-IMPLEMENTATION-GUIDE.md b/docs/content/docs/guides/IOT-IMPLEMENTATION-GUIDE.md index a79aa66..977b713 100644 --- a/docs/content/docs/guides/IOT-IMPLEMENTATION-GUIDE.md +++ b/docs/content/docs/guides/IOT-IMPLEMENTATION-GUIDE.md @@ -1,9 +1,6 @@ --- title: "IoT Implementation Guide" --- - -# IoT Implementation Guide - ## Overview This guide provides technical implementation details for integrating with the Bose SoundTouch IoT configuration system. It covers the AWS IoT Core integration, certificate management, and device shadow operations. diff --git a/docs/content/docs/guides/MAC-ADDRESS-MAPPING.md b/docs/content/docs/guides/MAC-ADDRESS-MAPPING.md index 11e30d6..7025626 100644 --- a/docs/content/docs/guides/MAC-ADDRESS-MAPPING.md +++ b/docs/content/docs/guides/MAC-ADDRESS-MAPPING.md @@ -1,9 +1,6 @@ --- title: "MAC Address to Serial Number Mapping" --- - -# MAC Address to Serial Number Mapping - **Understanding and troubleshooting device identification in SoundTouch service** This guide explains how the SoundTouch service handles device identification through MAC address to serial number mapping, and how to troubleshoot related issues. diff --git a/docs/content/docs/guides/MIGRATION-GUIDE.md b/docs/content/docs/guides/MIGRATION-GUIDE.md index 6dde814..eea99c7 100644 --- a/docs/content/docs/guides/MIGRATION-GUIDE.md +++ b/docs/content/docs/guides/MIGRATION-GUIDE.md @@ -1,9 +1,6 @@ --- title: "Migration Guide: From Bose Cloud to AfterTouch" --- - -# Migration Guide: From Bose Cloud to AfterTouch - This guide walks through the complete process of migrating your SoundTouch speakers from Bose's cloud services to **AfterTouch**, the replacement provided by `soundtouch-service`. By the end, your speakers will work fully independently of Bose's servers. For a shorter overview, see the [Survival Guide](SURVIVAL-GUIDE.md). For safety considerations and rollback options, see the [Migration & Safety Guide](MIGRATION-SAFETY.md). diff --git a/docs/content/docs/guides/MIGRATION-SAFETY.md b/docs/content/docs/guides/MIGRATION-SAFETY.md index 516eaed..bcd9d5c 100644 --- a/docs/content/docs/guides/MIGRATION-SAFETY.md +++ b/docs/content/docs/guides/MIGRATION-SAFETY.md @@ -1,9 +1,6 @@ --- title: "Migration & Safety Guide" --- - -# Migration & Safety Guide - Starting a migration on real hardware requires a "Safety First" approach. This guide outlines the safety features implemented in the `soundtouch-service` and provides a checklist for a successful migration. #### 🛠 Technical Safety Enhancements diff --git a/docs/content/docs/guides/MQTT-INTEGRATION-DESIGN.md b/docs/content/docs/guides/MQTT-INTEGRATION-DESIGN.md index 50f938a..5e6e3ba 100644 --- a/docs/content/docs/guides/MQTT-INTEGRATION-DESIGN.md +++ b/docs/content/docs/guides/MQTT-INTEGRATION-DESIGN.md @@ -1,9 +1,6 @@ --- title: "MQTT Integration Design for SoundTouch Service" --- - -# MQTT Integration Design for SoundTouch Service - ## Overview This document outlines the design for integrating MQTT support into the existing SoundTouch service to simulate AWS IoT Core functionality. The integration will provide real-time device communication, shadow state management, and prepare for the AWS IoT service shutdown in May 2026. diff --git a/docs/content/docs/guides/MUSIC-SERVICES.md b/docs/content/docs/guides/MUSIC-SERVICES.md index 1129933..8c8e8b0 100644 --- a/docs/content/docs/guides/MUSIC-SERVICES.md +++ b/docs/content/docs/guides/MUSIC-SERVICES.md @@ -1,9 +1,6 @@ --- title: "Connecting Music Services (Spotify & Amazon Music)" --- - -# Connecting Music Services (Spotify & Amazon Music) - This guide explains how to link your Spotify or Amazon Music account to AfterTouch so your speakers can stream music from those services. > For Spotify, a higher-level mental model of how the integration works — diff --git a/docs/content/docs/guides/ON-DEVICE-INSTALL-WALKTHROUGH.md b/docs/content/docs/guides/ON-DEVICE-INSTALL-WALKTHROUGH.md index cbdb9a9..9537e40 100644 --- a/docs/content/docs/guides/ON-DEVICE-INSTALL-WALKTHROUGH.md +++ b/docs/content/docs/guides/ON-DEVICE-INSTALL-WALKTHROUGH.md @@ -1,9 +1,6 @@ --- title: "On-Device Install Walkthrough" --- - -# On-Device Install Walkthrough - A complete end-to-end runbook for installing AfterTouch directly on a Bose SoundTouch speaker — from first SSH connection through verified radio preset playback. diff --git a/docs/content/docs/guides/RASPBERRY-PI.md b/docs/content/docs/guides/RASPBERRY-PI.md index 3f8da60..4ffcaba 100644 --- a/docs/content/docs/guides/RASPBERRY-PI.md +++ b/docs/content/docs/guides/RASPBERRY-PI.md @@ -1,9 +1,6 @@ --- title: "Raspberry Pi Installation Guide" --- - -# Raspberry Pi Installation Guide - This guide explains how to install the `soundtouch-service` as a persistent systemd service on a Raspberry Pi (tested on Raspberry Pi Zero 2W, 3, and 4). For a complete walkthrough — from install through speaker migration and preset setup — see diff --git a/docs/content/docs/guides/SELF-HOSTING.md b/docs/content/docs/guides/SELF-HOSTING.md index 5cf3def..96e3e9a 100644 --- a/docs/content/docs/guides/SELF-HOSTING.md +++ b/docs/content/docs/guides/SELF-HOSTING.md @@ -1,9 +1,6 @@ --- title: "Self-Hosting AfterTouch" --- - -# Self-Hosting AfterTouch - This guide walks you through running AfterTouch on your own computer or server. No programming knowledge required. --- diff --git a/docs/content/docs/guides/SOUNDTOUCH-SERVICE.md b/docs/content/docs/guides/SOUNDTOUCH-SERVICE.md index f8c0ef6..fa0ae5f 100644 --- a/docs/content/docs/guides/SOUNDTOUCH-SERVICE.md +++ b/docs/content/docs/guides/SOUNDTOUCH-SERVICE.md @@ -1,9 +1,6 @@ --- title: "SoundTouch Service" --- - -# SoundTouch Service - The `soundtouch-service` is a comprehensive local server that emulates Bose's cloud services, enabling offline SoundTouch device operation and advanced debugging capabilities. This service is particularly valuable given Bose's announcement that cloud support will end in May 2026. ## Overview diff --git a/docs/content/docs/guides/SURVIVAL-GUIDE.md b/docs/content/docs/guides/SURVIVAL-GUIDE.md index dc76608..b49a0a2 100644 --- a/docs/content/docs/guides/SURVIVAL-GUIDE.md +++ b/docs/content/docs/guides/SURVIVAL-GUIDE.md @@ -1,9 +1,6 @@ --- title: "Keeping Your Speakers Alive After the Bose Cloud Shutdown" --- - -# Keeping Your Speakers Alive After the Bose Cloud Shutdown - Bose shut down SoundTouch cloud services on **May 6, 2026**. Per the [official end-of-life page](https://www.bose.com/soundtouch-end-of-life), the following no longer work: - **Presets** — preset buttons on the product and in the app diff --git a/docs/content/docs/guides/TROUBLESHOOTING.md b/docs/content/docs/guides/TROUBLESHOOTING.md index a194606..6ae53d7 100644 --- a/docs/content/docs/guides/TROUBLESHOOTING.md +++ b/docs/content/docs/guides/TROUBLESHOOTING.md @@ -1,9 +1,6 @@ --- title: "SoundTouch Troubleshooting Guide" --- - -# SoundTouch Troubleshooting Guide - **Complete guide to diagnosing and fixing common SoundTouch Go client issues** This guide helps you quickly identify and resolve problems with the SoundTouch Go client library. Issues are organized by category with step-by-step solutions. diff --git a/docs/content/docs/reference/API-COOKBOOK.md b/docs/content/docs/reference/API-COOKBOOK.md index 77d331d..a639045 100644 --- a/docs/content/docs/reference/API-COOKBOOK.md +++ b/docs/content/docs/reference/API-COOKBOOK.md @@ -1,9 +1,6 @@ --- title: "SoundTouch API Cookbook" --- - -# SoundTouch API Cookbook - **Real-world patterns, recipes, and best practices for the SoundTouch Go client** This cookbook provides practical solutions to common SoundTouch integration challenges. Each recipe includes working code, error handling, and production considerations. diff --git a/docs/content/docs/reference/API-ENDPOINTS.md b/docs/content/docs/reference/API-ENDPOINTS.md index d68fe02..14e28d7 100644 --- a/docs/content/docs/reference/API-ENDPOINTS.md +++ b/docs/content/docs/reference/API-ENDPOINTS.md @@ -1,9 +1,6 @@ --- title: "Bose SoundTouch Web API - Endpoints Overview" --- - -# Bose SoundTouch Web API - Endpoints Overview - This document provides a comprehensive overview of the available API endpoints verified against the official Bose SoundTouch Web API v1.0 specification (January 7, 2026). **Acknowledgment**: Additional endpoints beyond the official API were discovered through the comprehensive [SoundTouch Plus Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API) maintained by the SoundTouch Plus community. Special thanks to @thlucas1 and contributors for documenting these working endpoints that enable full preset management and content navigation functionality. diff --git a/docs/content/docs/reference/BASS-CONTROLS.md b/docs/content/docs/reference/BASS-CONTROLS.md index dc1f269..1c8db2b 100644 --- a/docs/content/docs/reference/BASS-CONTROLS.md +++ b/docs/content/docs/reference/BASS-CONTROLS.md @@ -1,9 +1,6 @@ --- title: "Bass Control Guide" --- - -# Bass Control Guide - ## Overview The Bose SoundTouch Go client provides comprehensive bass control functionality through the `GET /bass` and `POST /bass` endpoints. This feature allows you to adjust bass levels from -9 (maximum bass cut) to +9 (maximum bass boost) with full validation and safety features. diff --git a/docs/content/docs/reference/CLOUD-API.md b/docs/content/docs/reference/CLOUD-API.md index 5a55300..7b3c72d 100644 --- a/docs/content/docs/reference/CLOUD-API.md +++ b/docs/content/docs/reference/CLOUD-API.md @@ -1,9 +1,6 @@ --- title: "Bose SoundTouch Cloud API Emulation (Marge/BMX/Stats)" --- - -# Bose SoundTouch Cloud API Emulation (Marge/BMX/Stats) - This document describes the cloud-emulation APIs provided by the SoundTouch service. These APIs mimic the Bose cloud services (Marge, BMX, Stats) that SoundTouch devices and the SoundTouch controller application (Stockholm) interact with. ## Marge API (Account & Configuration) diff --git a/docs/content/docs/reference/DEVICE-PAIRING-FLOW.md b/docs/content/docs/reference/DEVICE-PAIRING-FLOW.md index ffa40cd..a4ab8d7 100644 --- a/docs/content/docs/reference/DEVICE-PAIRING-FLOW.md +++ b/docs/content/docs/reference/DEVICE-PAIRING-FLOW.md @@ -1,9 +1,6 @@ --- title: "SoundTouch Device WebSocket API — Pairing & Operation Flow" --- - -# SoundTouch Device WebSocket API — Pairing & Operation Flow - Reference document derived from mitmproxy captures of the Bose SoundTouch Android app (`bose-pairing-20260502-155542`, `bose-pairing-20260502-165549`). diff --git a/docs/content/docs/reference/DISCOVERY.md b/docs/content/docs/reference/DISCOVERY.md index c2da103..59cfa0f 100644 --- a/docs/content/docs/reference/DISCOVERY.md +++ b/docs/content/docs/reference/DISCOVERY.md @@ -1,9 +1,6 @@ --- title: "SoundTouch Device Discovery" --- - -# SoundTouch Device Discovery - This document describes the various methods available for discovering Bose SoundTouch devices on your network. ## Overview diff --git a/docs/content/docs/reference/FEATURE-MAPPING.md b/docs/content/docs/reference/FEATURE-MAPPING.md index 3bed44e..2e38a45 100644 --- a/docs/content/docs/reference/FEATURE-MAPPING.md +++ b/docs/content/docs/reference/FEATURE-MAPPING.md @@ -1,9 +1,6 @@ --- title: "Feature Mapping Guide" --- - -# Feature Mapping Guide - This guide demonstrates the comprehensive endpoint-to-feature mapping system that helps you understand exactly what your SoundTouch device can do and how to use it effectively. ## Overview diff --git a/docs/content/docs/reference/KEY-CONTROLS.md b/docs/content/docs/reference/KEY-CONTROLS.md index d2d691e..5206727 100644 --- a/docs/content/docs/reference/KEY-CONTROLS.md +++ b/docs/content/docs/reference/KEY-CONTROLS.md @@ -1,9 +1,6 @@ --- title: "Key Control Implementation" --- - -# Key Control Implementation - This document describes the implementation of the POST `/key` endpoint for media control commands in the Bose SoundTouch API client. ## Overview diff --git a/docs/content/docs/reference/PRESET-MANAGEMENT.md b/docs/content/docs/reference/PRESET-MANAGEMENT.md index c27eb5a..5786904 100644 --- a/docs/content/docs/reference/PRESET-MANAGEMENT.md +++ b/docs/content/docs/reference/PRESET-MANAGEMENT.md @@ -1,9 +1,6 @@ --- title: "Preset Management - Bose SoundTouch API" --- - -# Preset Management - Bose SoundTouch API - This document covers preset management functionality in the Bose SoundTouch API client. ## Overview diff --git a/docs/content/docs/reference/SOURCE-SELECTION.md b/docs/content/docs/reference/SOURCE-SELECTION.md index 3103435..09b833f 100644 --- a/docs/content/docs/reference/SOURCE-SELECTION.md +++ b/docs/content/docs/reference/SOURCE-SELECTION.md @@ -1,9 +1,6 @@ --- title: "Source Selection Guide" --- - -# Source Selection Guide - ## Overview The Bose SoundTouch Go client provides comprehensive source selection functionality through the `POST /select` endpoint. This feature allows you to switch between different audio sources like Spotify, Bluetooth, AUX input, and various streaming services. diff --git a/docs/content/docs/reference/SPEAKER-ENDPOINT.md b/docs/content/docs/reference/SPEAKER-ENDPOINT.md index 0daeba6..baf6b72 100644 --- a/docs/content/docs/reference/SPEAKER-ENDPOINT.md +++ b/docs/content/docs/reference/SPEAKER-ENDPOINT.md @@ -1,9 +1,6 @@ --- title: "SoundTouch Speaker Endpoint Documentation" --- - -# SoundTouch Speaker Endpoint Documentation - This document describes the implementation of the `/speaker` endpoint for Bose SoundTouch devices, which enables Text-To-Speech (TTS) notifications and URL content playback. ## Overview diff --git a/docs/content/docs/reference/SYSTEM-ENDPOINTS.md b/docs/content/docs/reference/SYSTEM-ENDPOINTS.md index 86732b7..e400b20 100644 --- a/docs/content/docs/reference/SYSTEM-ENDPOINTS.md +++ b/docs/content/docs/reference/SYSTEM-ENDPOINTS.md @@ -1,9 +1,6 @@ --- title: "System Endpoints Documentation" --- - -# System Endpoints Documentation - This document provides comprehensive documentation for the system management endpoints in the Bose SoundTouch Go client library. ## Overview diff --git a/docs/content/docs/reference/VOLUME-CONTROLS.md b/docs/content/docs/reference/VOLUME-CONTROLS.md index c5ed60e..0bc5eb6 100644 --- a/docs/content/docs/reference/VOLUME-CONTROLS.md +++ b/docs/content/docs/reference/VOLUME-CONTROLS.md @@ -1,9 +1,6 @@ --- title: "Volume Control Implementation" --- - -# Volume Control Implementation - This document describes the implementation of the GET/POST `/volume` endpoints for volume management in the Bose SoundTouch API client. ## Overview diff --git a/docs/content/docs/reference/WEBSOCKET-EVENTS.md b/docs/content/docs/reference/WEBSOCKET-EVENTS.md index fe2530c..c47bd3b 100644 --- a/docs/content/docs/reference/WEBSOCKET-EVENTS.md +++ b/docs/content/docs/reference/WEBSOCKET-EVENTS.md @@ -1,9 +1,6 @@ --- title: "WebSocket Events - Real-time SoundTouch Monitoring" --- - -# WebSocket Events - Real-time SoundTouch Monitoring - This document describes the WebSocket event functionality for real-time monitoring of Bose SoundTouch devices. ## Overview diff --git a/docs/content/docs/reference/ZONE-MANAGEMENT.md b/docs/content/docs/reference/ZONE-MANAGEMENT.md index e5271cb..1a969c0 100644 --- a/docs/content/docs/reference/ZONE-MANAGEMENT.md +++ b/docs/content/docs/reference/ZONE-MANAGEMENT.md @@ -1,9 +1,6 @@ --- title: "Zone Management - Multiroom SoundTouch Control" --- - -# Zone Management - Multiroom SoundTouch Control - This document describes the comprehensive zone management functionality for controlling multiroom setups with Bose SoundTouch devices. ## Overview diff --git a/docs/content/docs/reference/spotify-account-addition.md b/docs/content/docs/reference/spotify-account-addition.md index e0b27c2..537f0a0 100644 --- a/docs/content/docs/reference/spotify-account-addition.md +++ b/docs/content/docs/reference/spotify-account-addition.md @@ -1,9 +1,6 @@ --- title: "Spotify Account Addition Technical Reference" --- - -# Spotify Account Addition Technical Reference - This document details the exact network requests performed by the Bose SoundTouch "Stockholm" application and the SoundTouch speaker when adding a new Spotify account. This information is based on analysis of the Stockholm firmware version `27.0.13-4277-8963611`. ## Flow Overview