diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..c19f296 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,32 @@ +name: Deploy Documentation +on: + push: + branches: + - main + paths: + - 'docs/**' + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v4 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'docs/' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index 701ba2a..8e2120c 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ soundtouch-cli --host 192.168.1.100 volume set --level 50 soundtouch-cli --host 192.168.1.100 preset list ``` -For full CLI documentation, see [docs/guides/CLI-REFERENCE.md](docs/guides/CLI-REFERENCE.md). +For full CLI documentation, see the [CLI Reference](https://gesellix.github.io/Bose-SoundTouch/guides/CLI-REFERENCE.md). ### SoundTouch Service (Cloud Shutdown Protection) @@ -82,11 +82,11 @@ soundtouch-service ``` Open `http://localhost:8000` in your browser to manage your devices. Documentation is also available directly through the web interface. -For a comprehensive guide on transitioning your system, see the [Bose Cloud Shutdown: Survival Guide](docs/guides/SURVIVAL-GUIDE.md). +For a comprehensive guide on transitioning your system, see the [Bose Cloud Shutdown: Survival Guide](https://gesellix.github.io/Bose-SoundTouch/guides/SURVIVAL-GUIDE.md). -Detailed service configuration and Docker instructions can be found in [docs/guides/SOUNDTOUCH-SERVICE.md](docs/guides/SOUNDTOUCH-SERVICE.md). +Detailed service configuration and Docker instructions can be found in [SoundTouch Service Guide](https://gesellix.github.io/Bose-SoundTouch/guides/SOUNDTOUCH-SERVICE.md). -For professional migration tips and safety measures, see the [Migration & Safety Guide](docs/guides/MIGRATION-SAFETY.md). +For professional migration tips and safety measures, see the [Migration & Safety Guide](https://gesellix.github.io/Bose-SoundTouch/guides/MIGRATION-SAFETY.md). ### Library Usage @@ -379,19 +379,19 @@ This library supports all Bose SoundTouch-compatible devices, including: ## Documentation - 📖 [Contributing Guide](CONTRIBUTING.md) - How to contribute to the project -- 📚 [API Reference](docs/reference/API-ENDPOINTS.md) - Complete endpoint documentation -- 🔧 [CLI Reference](docs/guides/CLI-REFERENCE.md) - Command-line tool guide -- 🌐 [SoundTouch Service Guide](docs/guides/SOUNDTOUCH-SERVICE.md) - Local service setup and migration -- 🎯 [Getting Started](docs/guides/GETTING-STARTED.md) - Detailed setup and usage -- 📻 [Preset Quick Start](docs/PRESET-QUICKSTART.md) - Favorite content management -- 🧭 [Navigation Guide](docs/NAVIGATION-GUIDE.md) - Content browsing and station management -- 📋 [Navigation API Reference](docs/API-NAVIGATION-REFERENCE.md) - Navigation API documentation -- ⚙️ [Advanced Features](docs/reference/SYSTEM-ENDPOINTS.md) - Advanced functionality -- 🏠 [Multiroom Setup](docs/reference/ZONE-MANAGEMENT.md) - Zone configuration guide -- ⚡ [WebSocket Events](docs/reference/WEBSOCKET-EVENTS.md) - Real-time event handling -- 🔔 [Speaker Notifications](docs/reference/SPEAKER-ENDPOINT.md) - TTS and audio notifications guide -- 🔍 [Device Discovery](docs/reference/DISCOVERY.md) - Discovery configuration -- 🛠️ [Troubleshooting](docs/guides/TROUBLESHOOTING.md) - Common issues and solutions +- 📚 [API Reference](https://gesellix.github.io/Bose-SoundTouch/reference/API-ENDPOINTS.md) - Complete endpoint documentation +- 🔧 [CLI Reference](https://gesellix.github.io/Bose-SoundTouch/guides/CLI-REFERENCE.md) - Command-line tool guide +- 🌐 [SoundTouch Service Guide](https://gesellix.github.io/Bose-SoundTouch/guides/SOUNDTOUCH-SERVICE.md) - Local service setup and migration +- 🎯 [Getting Started](https://gesellix.github.io/Bose-SoundTouch/guides/GETTING-STARTED.md) - Detailed setup and usage +- 📻 [Preset Quick Start](https://gesellix.github.io/Bose-SoundTouch/PRESET-QUICKSTART.md) - Favorite content management +- 🧭 [Navigation Guide](https://gesellix.github.io/Bose-SoundTouch/NAVIGATION-GUIDE.md) - Content browsing and station management +- 📋 [Navigation API Reference](https://gesellix.github.io/Bose-SoundTouch/API-NAVIGATION-REFERENCE.md) - Navigation API documentation +- ⚙️ [Advanced Features](https://gesellix.github.io/Bose-SoundTouch/reference/SYSTEM-ENDPOINTS.md) - Advanced functionality +- 🏠 [Multiroom Setup](https://gesellix.github.io/Bose-SoundTouch/reference/ZONE-MANAGEMENT.md) - Zone configuration guide +- ⚡ [WebSocket Events](https://gesellix.github.io/Bose-SoundTouch/reference/WEBSOCKET-EVENTS.md) - Real-time event handling +- 🔔 [Speaker Notifications](https://gesellix.github.io/Bose-SoundTouch/reference/SPEAKER-ENDPOINT.md) - TTS and audio notifications guide +- 🔍 [Device Discovery](https://gesellix.github.io/Bose-SoundTouch/reference/DISCOVERY.md) - Discovery configuration +- 🛠️ [Troubleshooting](https://gesellix.github.io/Bose-SoundTouch/guides/TROUBLESHOOTING.md) - Common issues and solutions ## Development @@ -526,13 +526,13 @@ If you discover new endpoints, features, or improvements through this library, p - 🐛 **Bug Reports**: [Create an issue](https://github.com/gesellix/bose-soundtouch/issues/new) - 💡 **Feature Requests**: [Start a discussion](https://github.com/gesellix/bose-soundtouch/discussions) - ❓ **Questions**: Check [existing discussions](https://github.com/gesellix/bose-soundtouch/discussions) -- 📖 **Documentation**: Browse the [docs/](docs/) directory -- 🔍 **New Discoveries**: See [Undocumented Community Features](docs/UNDOCUMENTED-COMMUNITY-FEATURES.md) for advanced API research -- 🌐 **Upstream Analysis**: [Upstream URLs & Domains](docs/analysis/UPSTREAM-URLS.md) for cloud dependency research -- 🔧 **Redirection Guide**: [Device Redirect Methods](docs/analysis/DEVICE-REDIRECT-METHODS.md) for custom service setup -- 🐣 **Initial Setup**: [Device Initial Setup Variants](docs/guides/DEVICE-INITIAL-SETUP.md) for out-of-the-box configuration -- 📜 **Logging & Debugging**: [Device Logging Guide](docs/DEVICE-LOGGING.md) for accessing system and traffic logs -- 🔒 **HTTPS & CA Setup**: [HTTPS & Custom CA Guide](docs/guides/HTTPS-SETUP.md) for secure `/etc/hosts` redirection +- 📖 **Documentation**: [Online Documentation](https://gesellix.github.io/Bose-SoundTouch/) +- 🔍 **New Discoveries**: [Undocumented Community Features](https://gesellix.github.io/Bose-SoundTouch/UNDOCUMENTED-COMMUNITY-FEATURES.md) +- 🌐 **Upstream Analysis**: [Upstream URLs & Domains](https://gesellix.github.io/Bose-SoundTouch/analysis/UPSTREAM-URLS.md) +- 🔧 **Redirection Guide**: [Device Redirect Methods](https://gesellix.github.io/Bose-SoundTouch/analysis/DEVICE-REDIRECT-METHODS.md) +- 🐣 **Initial Setup**: [Device Initial Setup Variants](https://gesellix.github.io/Bose-SoundTouch/guides/DEVICE-INITIAL-SETUP.md) +- 📜 **Logging & Debugging**: [Device Logging Guide](https://gesellix.github.io/Bose-SoundTouch/DEVICE-LOGGING.md) +- 🔒 **HTTPS & CA Setup**: [HTTPS & Custom CA Guide](https://gesellix.github.io/Bose-SoundTouch/guides/HTTPS-SETUP.md) --- diff --git a/pkg/service/handlers/web/index.html b/pkg/service/handlers/web/index.html index 5db1cb7..3f242c0 100644 --- a/pkg/service/handlers/web/index.html +++ b/pkg/service/handlers/web/index.html @@ -60,14 +60,14 @@
⚠️ Safety First: Before starting any migration, please read our - Professional Migration & Safety Guide. + Professional Migration & Safety Guide. The toolkit automatically creates backups, but understanding the process is key to a smooth transition.

Useful Links