From b2bd96a4d0537621a79b778bad76dcab0d9b8be8 Mon Sep 17 00:00:00 2001 From: Tobias Gesellchen Date: Sun, 24 May 2026 12:26:09 +0200 Subject: [PATCH] chore: add Hugo go.sum and update gitignore for Hugo artifacts MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add docs/go.sum (Hextra v0.12.3 checksums) produced by hugo mod tidy. Update docs/go.mod with the resolved module version. Ignore docs/.hugo_build.lock, docs/public/, and docs/resources/ — all are generated by Hugo locally and not needed in the repo. Co-Authored-By: Claude Sonnet 4.6 --- .gitignore | 6 ++++++ docker-compose.docs.yml | 4 +++- docs/content/docs/analysis/_index.md | 4 ++++ .../{ => appendix}/API-NAVIGATION-REFERENCE.md | 2 ++ docs/content/docs/{ => appendix}/CLAUDE.md | 2 ++ .../CONTENT-SELECTION-IMPLEMENTATION.md | 2 ++ .../DEVICE-CUSTOMIZATION-SETUP.md | 2 ++ .../docs/{ => appendix}/DEVICE-LOGGING.md | 2 ++ .../docs/{ => appendix}/DEVICE-SETUP.md | 2 ++ .../docs/{ => appendix}/DIAGNOSTIC-EXPORT.md | 2 ++ .../EXTERNAL-SERVICES-ABSTRACTION.md | 2 ++ .../docs/{ => appendix}/FEATURE_HISTORY.md | 2 ++ .../docs/{ => appendix}/HOST-PORT-PARSING.md | 2 ++ .../{ => appendix}/MANUAL-NETWORK-DISCOVERY.md | 2 ++ .../docs/{ => appendix}/NAVIGATION-GUIDE.md | 2 ++ .../OFFICIAL-API-VERIFICATION.md | 2 ++ .../docs/{ => appendix}/PARITY-IMPROVEMENTS.md | 2 ++ .../{ => appendix}/PARITY-OPENCLOUDTOUCH.md | 2 ++ .../docs/{ => appendix}/PARITY-SOUNDCORK.md | 2 ++ .../docs/{ => appendix}/PRESET-QUICKSTART.md | 2 ++ .../docs/{ => appendix}/PROJECT-PATTERNS.md | 2 ++ .../REQUEST_RECORDING_CONCEPT.md | 2 ++ .../SCMUDC-ENRICHMENT-IMPLEMENTATION.md | 2 ++ .../SERVICE-AVAILABILITY-IMPLEMENTATION.md | 2 ++ .../SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md | 2 ++ .../UNDOCUMENTED-COMMUNITY-FEATURES.md | 2 ++ .../{ => appendix}/UNIMPLEMENTED-ENDPOINTS.md | 2 ++ docs/content/docs/appendix/_index.md | 9 +++++++++ ...evice-lifecycle-and-power-on-enhancement.md | 2 ++ .../{ => appendix}/device-lifecycle-summary.md | 2 ++ .../power-on-implementation-guide.md | 2 ++ .../docs/{ => appendix}/preset-store.md | 2 ++ .../{ => appendix}/scmudc-events-analysis.md | 2 ++ .../{ => appendix}/soundtouch-web-roadmap.md | 2 ++ .../{ => appendix}/stockholm-port-guide.md | 2 ++ docs/content/docs/architecture/_index.md | 4 ++++ docs/content/docs/concepts/_index.md | 4 ++++ docs/content/docs/guides/_index.md | 6 ++++++ docs/content/docs/reference/_index.md | 4 ++++ docs/go.mod | 2 ++ docs/go.sum | 2 ++ docs/hugo.toml | 9 +++++++++ docs/layouts/_default/_markup/render-link.html | 18 ++++++++++++++++++ 43 files changed, 133 insertions(+), 1 deletion(-) create mode 100644 docs/content/docs/analysis/_index.md rename docs/content/docs/{ => appendix}/API-NAVIGATION-REFERENCE.md (99%) rename docs/content/docs/{ => appendix}/CLAUDE.md (99%) rename docs/content/docs/{ => appendix}/CONTENT-SELECTION-IMPLEMENTATION.md (99%) rename docs/content/docs/{ => appendix}/DEVICE-CUSTOMIZATION-SETUP.md (99%) rename docs/content/docs/{ => appendix}/DEVICE-LOGGING.md (99%) rename docs/content/docs/{ => appendix}/DEVICE-SETUP.md (99%) rename docs/content/docs/{ => appendix}/DIAGNOSTIC-EXPORT.md (99%) rename docs/content/docs/{ => appendix}/EXTERNAL-SERVICES-ABSTRACTION.md (99%) rename docs/content/docs/{ => appendix}/FEATURE_HISTORY.md (99%) rename docs/content/docs/{ => appendix}/HOST-PORT-PARSING.md (99%) rename docs/content/docs/{ => appendix}/MANUAL-NETWORK-DISCOVERY.md (99%) rename docs/content/docs/{ => appendix}/NAVIGATION-GUIDE.md (99%) rename docs/content/docs/{ => appendix}/OFFICIAL-API-VERIFICATION.md (99%) rename docs/content/docs/{ => appendix}/PARITY-IMPROVEMENTS.md (99%) rename docs/content/docs/{ => appendix}/PARITY-OPENCLOUDTOUCH.md (99%) rename docs/content/docs/{ => appendix}/PARITY-SOUNDCORK.md (99%) rename docs/content/docs/{ => appendix}/PRESET-QUICKSTART.md (99%) rename docs/content/docs/{ => appendix}/PROJECT-PATTERNS.md (99%) rename docs/content/docs/{ => appendix}/REQUEST_RECORDING_CONCEPT.md (99%) rename docs/content/docs/{ => appendix}/SCMUDC-ENRICHMENT-IMPLEMENTATION.md (99%) rename docs/content/docs/{ => appendix}/SERVICE-AVAILABILITY-IMPLEMENTATION.md (99%) rename docs/content/docs/{ => appendix}/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md (99%) rename docs/content/docs/{ => appendix}/UNDOCUMENTED-COMMUNITY-FEATURES.md (99%) rename docs/content/docs/{ => appendix}/UNIMPLEMENTED-ENDPOINTS.md (99%) create mode 100644 docs/content/docs/appendix/_index.md rename docs/content/docs/{ => appendix}/device-lifecycle-and-power-on-enhancement.md (99%) rename docs/content/docs/{ => appendix}/device-lifecycle-summary.md (99%) rename docs/content/docs/{ => appendix}/power-on-implementation-guide.md (99%) rename docs/content/docs/{ => appendix}/preset-store.md (99%) rename docs/content/docs/{ => appendix}/scmudc-events-analysis.md (99%) rename docs/content/docs/{ => appendix}/soundtouch-web-roadmap.md (99%) rename docs/content/docs/{ => appendix}/stockholm-port-guide.md (99%) create mode 100644 docs/content/docs/architecture/_index.md create mode 100644 docs/content/docs/concepts/_index.md create mode 100644 docs/content/docs/guides/_index.md create mode 100644 docs/content/docs/reference/_index.md create mode 100644 docs/go.sum create mode 100644 docs/layouts/_default/_markup/render-link.html diff --git a/.gitignore b/.gitignore index ca06d9d..3aa2b09 100644 --- a/.gitignore +++ b/.gitignore @@ -122,3 +122,9 @@ SERVICE-HEALTH.md # Diagnostic encryption keys — private key stays local with the maintainer keys/private/ + +# Hugo (docs site) +# Hugo build artifacts (docs site) +docs/.hugo_build.lock +docs/public/ +docs/resources/ diff --git a/docker-compose.docs.yml b/docker-compose.docs.yml index 09a6961..76949f5 100644 --- a/docker-compose.docs.yml +++ b/docker-compose.docs.yml @@ -15,8 +15,10 @@ services: hugo: image: hugomods/hugo:exts # --source docs/ because docs/ is the Hugo root inside the repo. + # --baseURL / overrides the production subpath (/Bose-SoundTouch/) so + # absolute links work at http://localhost:1313/ during local development. # The full repo is mounted so enableGitInfo can read git history. - command: server --source docs/ --bind 0.0.0.0 --buildDrafts --navigateToChanged + command: server --source docs/ --baseURL / --bind 0.0.0.0 --buildDrafts --navigateToChanged ports: - "1313:1313" volumes: diff --git a/docs/content/docs/analysis/_index.md b/docs/content/docs/analysis/_index.md new file mode 100644 index 0000000..6d25dba --- /dev/null +++ b/docs/content/docs/analysis/_index.md @@ -0,0 +1,4 @@ +--- +title: "Analysis & Research" +weight: 4 +--- diff --git a/docs/content/docs/API-NAVIGATION-REFERENCE.md b/docs/content/docs/appendix/API-NAVIGATION-REFERENCE.md similarity index 99% rename from docs/content/docs/API-NAVIGATION-REFERENCE.md rename to docs/content/docs/appendix/API-NAVIGATION-REFERENCE.md index f95970e..18776b4 100644 --- a/docs/content/docs/API-NAVIGATION-REFERENCE.md +++ b/docs/content/docs/appendix/API-NAVIGATION-REFERENCE.md @@ -1,5 +1,7 @@ --- title: "Navigation API Reference" +sidebar: + exclude: true --- # Navigation API Reference diff --git a/docs/content/docs/CLAUDE.md b/docs/content/docs/appendix/CLAUDE.md similarity index 99% rename from docs/content/docs/CLAUDE.md rename to docs/content/docs/appendix/CLAUDE.md index 4050876..c1ed7da 100644 --- a/docs/content/docs/CLAUDE.md +++ b/docs/content/docs/appendix/CLAUDE.md @@ -1,5 +1,7 @@ --- title: "CLAUDE.md - Development Guidelines for Bose SoundTouch Project" +sidebar: + exclude: true --- # CLAUDE.md - Development Guidelines for Bose SoundTouch Project diff --git a/docs/content/docs/CONTENT-SELECTION-IMPLEMENTATION.md b/docs/content/docs/appendix/CONTENT-SELECTION-IMPLEMENTATION.md similarity index 99% rename from docs/content/docs/CONTENT-SELECTION-IMPLEMENTATION.md rename to docs/content/docs/appendix/CONTENT-SELECTION-IMPLEMENTATION.md index d5c1112..01f4b4e 100644 --- a/docs/content/docs/CONTENT-SELECTION-IMPLEMENTATION.md +++ b/docs/content/docs/appendix/CONTENT-SELECTION-IMPLEMENTATION.md @@ -1,5 +1,7 @@ --- title: "Content Selection Implementation Summary" +sidebar: + exclude: true --- # Content Selection Implementation Summary diff --git a/docs/content/docs/DEVICE-CUSTOMIZATION-SETUP.md b/docs/content/docs/appendix/DEVICE-CUSTOMIZATION-SETUP.md similarity index 99% rename from docs/content/docs/DEVICE-CUSTOMIZATION-SETUP.md rename to docs/content/docs/appendix/DEVICE-CUSTOMIZATION-SETUP.md index 646bcf5..e6b36ad 100644 --- a/docs/content/docs/DEVICE-CUSTOMIZATION-SETUP.md +++ b/docs/content/docs/appendix/DEVICE-CUSTOMIZATION-SETUP.md @@ -1,5 +1,7 @@ --- title: "Device Customization Setup Guide" +sidebar: + exclude: true --- # Device Customization Setup Guide diff --git a/docs/content/docs/DEVICE-LOGGING.md b/docs/content/docs/appendix/DEVICE-LOGGING.md similarity index 99% rename from docs/content/docs/DEVICE-LOGGING.md rename to docs/content/docs/appendix/DEVICE-LOGGING.md index 9509ef5..c9f0285 100644 --- a/docs/content/docs/DEVICE-LOGGING.md +++ b/docs/content/docs/appendix/DEVICE-LOGGING.md @@ -1,5 +1,7 @@ --- title: "Device Logging & Troubleshooting" +sidebar: + exclude: true --- # Device Logging & Troubleshooting diff --git a/docs/content/docs/DEVICE-SETUP.md b/docs/content/docs/appendix/DEVICE-SETUP.md similarity index 99% rename from docs/content/docs/DEVICE-SETUP.md rename to docs/content/docs/appendix/DEVICE-SETUP.md index 7dbd2a8..9188d1c 100644 --- a/docs/content/docs/DEVICE-SETUP.md +++ b/docs/content/docs/appendix/DEVICE-SETUP.md @@ -1,5 +1,7 @@ --- title: "Bose SoundTouch Device Setup Flow" +sidebar: + exclude: true --- # Bose SoundTouch Device Setup Flow diff --git a/docs/content/docs/DIAGNOSTIC-EXPORT.md b/docs/content/docs/appendix/DIAGNOSTIC-EXPORT.md similarity index 99% rename from docs/content/docs/DIAGNOSTIC-EXPORT.md rename to docs/content/docs/appendix/DIAGNOSTIC-EXPORT.md index fee72ab..dc703e8 100644 --- a/docs/content/docs/DIAGNOSTIC-EXPORT.md +++ b/docs/content/docs/appendix/DIAGNOSTIC-EXPORT.md @@ -1,5 +1,7 @@ --- title: "Encrypted Diagnostic Export" +sidebar: + exclude: true --- # Encrypted Diagnostic Export diff --git a/docs/content/docs/EXTERNAL-SERVICES-ABSTRACTION.md b/docs/content/docs/appendix/EXTERNAL-SERVICES-ABSTRACTION.md similarity index 99% rename from docs/content/docs/EXTERNAL-SERVICES-ABSTRACTION.md rename to docs/content/docs/appendix/EXTERNAL-SERVICES-ABSTRACTION.md index ff7834c..516e9d4 100644 --- a/docs/content/docs/EXTERNAL-SERVICES-ABSTRACTION.md +++ b/docs/content/docs/appendix/EXTERNAL-SERVICES-ABSTRACTION.md @@ -1,5 +1,7 @@ --- title: "Technical Proposal: External Service Provider Abstraction" +sidebar: + exclude: true --- # Technical Proposal: External Service Provider Abstraction diff --git a/docs/content/docs/FEATURE_HISTORY.md b/docs/content/docs/appendix/FEATURE_HISTORY.md similarity index 99% rename from docs/content/docs/FEATURE_HISTORY.md rename to docs/content/docs/appendix/FEATURE_HISTORY.md index 4f91867..7717fb4 100644 --- a/docs/content/docs/FEATURE_HISTORY.md +++ b/docs/content/docs/appendix/FEATURE_HISTORY.md @@ -1,5 +1,7 @@ --- title: "Feature Development History" +sidebar: + exclude: true --- # Feature Development History diff --git a/docs/content/docs/HOST-PORT-PARSING.md b/docs/content/docs/appendix/HOST-PORT-PARSING.md similarity index 99% rename from docs/content/docs/HOST-PORT-PARSING.md rename to docs/content/docs/appendix/HOST-PORT-PARSING.md index f3a6136..e3d2738 100644 --- a/docs/content/docs/HOST-PORT-PARSING.md +++ b/docs/content/docs/appendix/HOST-PORT-PARSING.md @@ -1,5 +1,7 @@ --- title: "Host:Port Parsing Feature" +sidebar: + exclude: true --- # Host:Port Parsing Feature diff --git a/docs/content/docs/MANUAL-NETWORK-DISCOVERY.md b/docs/content/docs/appendix/MANUAL-NETWORK-DISCOVERY.md similarity index 99% rename from docs/content/docs/MANUAL-NETWORK-DISCOVERY.md rename to docs/content/docs/appendix/MANUAL-NETWORK-DISCOVERY.md index 3ab044c..a4cf78c 100644 --- a/docs/content/docs/MANUAL-NETWORK-DISCOVERY.md +++ b/docs/content/docs/appendix/MANUAL-NETWORK-DISCOVERY.md @@ -1,5 +1,7 @@ --- title: "Manual Network Discovery on macOS" +sidebar: + exclude: true --- # Manual Network Discovery on macOS diff --git a/docs/content/docs/NAVIGATION-GUIDE.md b/docs/content/docs/appendix/NAVIGATION-GUIDE.md similarity index 99% rename from docs/content/docs/NAVIGATION-GUIDE.md rename to docs/content/docs/appendix/NAVIGATION-GUIDE.md index 23bcd6d..1bd7b80 100644 --- a/docs/content/docs/NAVIGATION-GUIDE.md +++ b/docs/content/docs/appendix/NAVIGATION-GUIDE.md @@ -1,5 +1,7 @@ --- title: "Navigation and Station Management Guide" +sidebar: + exclude: true --- # Navigation and Station Management Guide diff --git a/docs/content/docs/OFFICIAL-API-VERIFICATION.md b/docs/content/docs/appendix/OFFICIAL-API-VERIFICATION.md similarity index 99% rename from docs/content/docs/OFFICIAL-API-VERIFICATION.md rename to docs/content/docs/appendix/OFFICIAL-API-VERIFICATION.md index f9f142b..d5c4fb8 100644 --- a/docs/content/docs/OFFICIAL-API-VERIFICATION.md +++ b/docs/content/docs/appendix/OFFICIAL-API-VERIFICATION.md @@ -1,5 +1,7 @@ --- title: "Official SoundTouch Web API Verification" +sidebar: + exclude: true --- # Official SoundTouch Web API Verification diff --git a/docs/content/docs/PARITY-IMPROVEMENTS.md b/docs/content/docs/appendix/PARITY-IMPROVEMENTS.md similarity index 99% rename from docs/content/docs/PARITY-IMPROVEMENTS.md rename to docs/content/docs/appendix/PARITY-IMPROVEMENTS.md index 7e43889..3877140 100644 --- a/docs/content/docs/PARITY-IMPROVEMENTS.md +++ b/docs/content/docs/appendix/PARITY-IMPROVEMENTS.md @@ -1,5 +1,7 @@ --- title: "Parity Improvements" +sidebar: + exclude: true --- ### Overview of Recent Improvements and Next Steps diff --git a/docs/content/docs/PARITY-OPENCLOUDTOUCH.md b/docs/content/docs/appendix/PARITY-OPENCLOUDTOUCH.md similarity index 99% rename from docs/content/docs/PARITY-OPENCLOUDTOUCH.md rename to docs/content/docs/appendix/PARITY-OPENCLOUDTOUCH.md index b488cb3..688e96b 100644 --- a/docs/content/docs/PARITY-OPENCLOUDTOUCH.md +++ b/docs/content/docs/appendix/PARITY-OPENCLOUDTOUCH.md @@ -1,5 +1,7 @@ --- title: "Parity Analysis: Bose-SoundTouch (Go) vs. OpenCloudTouch (Python)" +sidebar: + exclude: true --- # Parity Analysis: Bose-SoundTouch (Go) vs. OpenCloudTouch (Python) diff --git a/docs/content/docs/PARITY-SOUNDCORK.md b/docs/content/docs/appendix/PARITY-SOUNDCORK.md similarity index 99% rename from docs/content/docs/PARITY-SOUNDCORK.md rename to docs/content/docs/appendix/PARITY-SOUNDCORK.md index 1a15112..e644b2a 100644 --- a/docs/content/docs/PARITY-SOUNDCORK.md +++ b/docs/content/docs/appendix/PARITY-SOUNDCORK.md @@ -1,5 +1,7 @@ --- title: "Parity Analysis: Bose-SoundTouch (Go) vs. SoundCork (Python)" +sidebar: + exclude: true --- # Parity Analysis: Bose-SoundTouch (Go) vs. SoundCork (Python) diff --git a/docs/content/docs/PRESET-QUICKSTART.md b/docs/content/docs/appendix/PRESET-QUICKSTART.md similarity index 99% rename from docs/content/docs/PRESET-QUICKSTART.md rename to docs/content/docs/appendix/PRESET-QUICKSTART.md index dc8401d..cd67852 100644 --- a/docs/content/docs/PRESET-QUICKSTART.md +++ b/docs/content/docs/appendix/PRESET-QUICKSTART.md @@ -1,5 +1,7 @@ --- title: "Preset Management Quick Start Guide" +sidebar: + exclude: true --- # Preset Management Quick Start Guide diff --git a/docs/content/docs/PROJECT-PATTERNS.md b/docs/content/docs/appendix/PROJECT-PATTERNS.md similarity index 99% rename from docs/content/docs/PROJECT-PATTERNS.md rename to docs/content/docs/appendix/PROJECT-PATTERNS.md index b098df8..1b45d2e 100644 --- a/docs/content/docs/PROJECT-PATTERNS.md +++ b/docs/content/docs/appendix/PROJECT-PATTERNS.md @@ -1,5 +1,7 @@ --- title: "Project Structure Patterns: Bose SoundTouch API Client" +sidebar: + exclude: true --- # Project Structure Patterns: Bose SoundTouch API Client diff --git a/docs/content/docs/REQUEST_RECORDING_CONCEPT.md b/docs/content/docs/appendix/REQUEST_RECORDING_CONCEPT.md similarity index 99% rename from docs/content/docs/REQUEST_RECORDING_CONCEPT.md rename to docs/content/docs/appendix/REQUEST_RECORDING_CONCEPT.md index cadb1ea..b8e4ffe 100644 --- a/docs/content/docs/REQUEST_RECORDING_CONCEPT.md +++ b/docs/content/docs/appendix/REQUEST_RECORDING_CONCEPT.md @@ -1,5 +1,7 @@ --- title: "Request Recording Concept" +sidebar: + exclude: true --- # Request Recording Concept diff --git a/docs/content/docs/SCMUDC-ENRICHMENT-IMPLEMENTATION.md b/docs/content/docs/appendix/SCMUDC-ENRICHMENT-IMPLEMENTATION.md similarity index 99% rename from docs/content/docs/SCMUDC-ENRICHMENT-IMPLEMENTATION.md rename to docs/content/docs/appendix/SCMUDC-ENRICHMENT-IMPLEMENTATION.md index f11635d..4544f1b 100644 --- a/docs/content/docs/SCMUDC-ENRICHMENT-IMPLEMENTATION.md +++ b/docs/content/docs/appendix/SCMUDC-ENRICHMENT-IMPLEMENTATION.md @@ -1,5 +1,7 @@ --- title: "SCMUDC Enrichment Implementation Summary" +sidebar: + exclude: true --- # SCMUDC Enrichment Implementation Summary diff --git a/docs/content/docs/SERVICE-AVAILABILITY-IMPLEMENTATION.md b/docs/content/docs/appendix/SERVICE-AVAILABILITY-IMPLEMENTATION.md similarity index 99% rename from docs/content/docs/SERVICE-AVAILABILITY-IMPLEMENTATION.md rename to docs/content/docs/appendix/SERVICE-AVAILABILITY-IMPLEMENTATION.md index 22ed32b..8320409 100644 --- a/docs/content/docs/SERVICE-AVAILABILITY-IMPLEMENTATION.md +++ b/docs/content/docs/appendix/SERVICE-AVAILABILITY-IMPLEMENTATION.md @@ -1,5 +1,7 @@ --- title: "Service Availability Implementation Summary" +sidebar: + exclude: true --- # Service Availability Implementation Summary diff --git a/docs/content/docs/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md b/docs/content/docs/appendix/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md similarity index 99% rename from docs/content/docs/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md rename to docs/content/docs/appendix/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md index a2bb715..fbf6b10 100644 --- a/docs/content/docs/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md +++ b/docs/content/docs/appendix/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md @@ -1,5 +1,7 @@ --- title: "🎉 Introducing SoundTouch Service: Local Cloud Service Emulation" +sidebar: + exclude: true --- # 🎉 Introducing SoundTouch Service: Local Cloud Service Emulation diff --git a/docs/content/docs/UNDOCUMENTED-COMMUNITY-FEATURES.md b/docs/content/docs/appendix/UNDOCUMENTED-COMMUNITY-FEATURES.md similarity index 99% rename from docs/content/docs/UNDOCUMENTED-COMMUNITY-FEATURES.md rename to docs/content/docs/appendix/UNDOCUMENTED-COMMUNITY-FEATURES.md index 7b17d28..e9a5a5a 100644 --- a/docs/content/docs/UNDOCUMENTED-COMMUNITY-FEATURES.md +++ b/docs/content/docs/appendix/UNDOCUMENTED-COMMUNITY-FEATURES.md @@ -1,5 +1,7 @@ --- title: "Undocumented Community Features & API Discoveries" +sidebar: + exclude: true --- # Undocumented Community Features & API Discoveries diff --git a/docs/content/docs/UNIMPLEMENTED-ENDPOINTS.md b/docs/content/docs/appendix/UNIMPLEMENTED-ENDPOINTS.md similarity index 99% rename from docs/content/docs/UNIMPLEMENTED-ENDPOINTS.md rename to docs/content/docs/appendix/UNIMPLEMENTED-ENDPOINTS.md index e8e2941..3b9bbfb 100644 --- a/docs/content/docs/UNIMPLEMENTED-ENDPOINTS.md +++ b/docs/content/docs/appendix/UNIMPLEMENTED-ENDPOINTS.md @@ -1,5 +1,7 @@ --- title: "Unimplemented SoundTouch API Endpoints" +sidebar: + exclude: true --- # Unimplemented SoundTouch API Endpoints diff --git a/docs/content/docs/appendix/_index.md b/docs/content/docs/appendix/_index.md new file mode 100644 index 0000000..387bdaf --- /dev/null +++ b/docs/content/docs/appendix/_index.md @@ -0,0 +1,9 @@ +--- +title: "Appendix" +weight: 99 +sidebar: + open: false +--- + +Internal design documents, implementation notes, and historical records. +These are developer and maintainer references, not user guides. diff --git a/docs/content/docs/device-lifecycle-and-power-on-enhancement.md b/docs/content/docs/appendix/device-lifecycle-and-power-on-enhancement.md similarity index 99% rename from docs/content/docs/device-lifecycle-and-power-on-enhancement.md rename to docs/content/docs/appendix/device-lifecycle-and-power-on-enhancement.md index 2777f2b..8a543cf 100644 --- a/docs/content/docs/device-lifecycle-and-power-on-enhancement.md +++ b/docs/content/docs/appendix/device-lifecycle-and-power-on-enhancement.md @@ -1,5 +1,7 @@ --- title: "Device Lifecycle and /power_on Enhancement" +sidebar: + exclude: true --- # Device Lifecycle and /power_on Enhancement diff --git a/docs/content/docs/device-lifecycle-summary.md b/docs/content/docs/appendix/device-lifecycle-summary.md similarity index 99% rename from docs/content/docs/device-lifecycle-summary.md rename to docs/content/docs/appendix/device-lifecycle-summary.md index e7cb605..4172215 100644 --- a/docs/content/docs/device-lifecycle-summary.md +++ b/docs/content/docs/appendix/device-lifecycle-summary.md @@ -1,5 +1,7 @@ --- title: "Device Lifecycle Analysis - Executive Summary" +sidebar: + exclude: true --- # Device Lifecycle Analysis - Executive Summary diff --git a/docs/content/docs/power-on-implementation-guide.md b/docs/content/docs/appendix/power-on-implementation-guide.md similarity index 99% rename from docs/content/docs/power-on-implementation-guide.md rename to docs/content/docs/appendix/power-on-implementation-guide.md index e7f0bce..389e4f8 100644 --- a/docs/content/docs/power-on-implementation-guide.md +++ b/docs/content/docs/appendix/power-on-implementation-guide.md @@ -1,5 +1,7 @@ --- title: "/power_on Implementation Guide" +sidebar: + exclude: true --- # /power_on Implementation Guide diff --git a/docs/content/docs/preset-store.md b/docs/content/docs/appendix/preset-store.md similarity index 99% rename from docs/content/docs/preset-store.md rename to docs/content/docs/appendix/preset-store.md index d49c744..ad2b85a 100644 --- a/docs/content/docs/preset-store.md +++ b/docs/content/docs/appendix/preset-store.md @@ -1,5 +1,7 @@ --- title: "SoundTouch `/storePreset` Implementation Guide" +sidebar: + exclude: true --- # SoundTouch `/storePreset` Implementation Guide diff --git a/docs/content/docs/scmudc-events-analysis.md b/docs/content/docs/appendix/scmudc-events-analysis.md similarity index 99% rename from docs/content/docs/scmudc-events-analysis.md rename to docs/content/docs/appendix/scmudc-events-analysis.md index 2a291aa..298a3b8 100644 --- a/docs/content/docs/scmudc-events-analysis.md +++ b/docs/content/docs/appendix/scmudc-events-analysis.md @@ -1,5 +1,7 @@ --- title: "SCMUDC Events Analysis" +sidebar: + exclude: true --- # SCMUDC Events Analysis diff --git a/docs/content/docs/soundtouch-web-roadmap.md b/docs/content/docs/appendix/soundtouch-web-roadmap.md similarity index 99% rename from docs/content/docs/soundtouch-web-roadmap.md rename to docs/content/docs/appendix/soundtouch-web-roadmap.md index 42c4db2..c3a56d0 100644 --- a/docs/content/docs/soundtouch-web-roadmap.md +++ b/docs/content/docs/appendix/soundtouch-web-roadmap.md @@ -1,5 +1,7 @@ --- title: "soundtouch-web: remaining features" +sidebar: + exclude: true --- # soundtouch-web: remaining features diff --git a/docs/content/docs/stockholm-port-guide.md b/docs/content/docs/appendix/stockholm-port-guide.md similarity index 99% rename from docs/content/docs/stockholm-port-guide.md rename to docs/content/docs/appendix/stockholm-port-guide.md index 8f78640..fc74189 100644 --- a/docs/content/docs/stockholm-port-guide.md +++ b/docs/content/docs/appendix/stockholm-port-guide.md @@ -1,5 +1,7 @@ --- title: "Stockholm Backend — Port Guide for Bose-SoundTouch (Go)" +sidebar: + exclude: true --- # Stockholm Backend — Port Guide for Bose-SoundTouch (Go) diff --git a/docs/content/docs/architecture/_index.md b/docs/content/docs/architecture/_index.md new file mode 100644 index 0000000..b93fd3c --- /dev/null +++ b/docs/content/docs/architecture/_index.md @@ -0,0 +1,4 @@ +--- +title: "Architecture" +weight: 5 +--- diff --git a/docs/content/docs/concepts/_index.md b/docs/content/docs/concepts/_index.md new file mode 100644 index 0000000..53b4d91 --- /dev/null +++ b/docs/content/docs/concepts/_index.md @@ -0,0 +1,4 @@ +--- +title: "Concepts" +weight: 3 +--- diff --git a/docs/content/docs/guides/_index.md b/docs/content/docs/guides/_index.md new file mode 100644 index 0000000..43ec3df --- /dev/null +++ b/docs/content/docs/guides/_index.md @@ -0,0 +1,6 @@ +--- +title: "User Guides" +weight: 1 +sidebar: + open: true +--- diff --git a/docs/content/docs/reference/_index.md b/docs/content/docs/reference/_index.md new file mode 100644 index 0000000..ddf62ea --- /dev/null +++ b/docs/content/docs/reference/_index.md @@ -0,0 +1,4 @@ +--- +title: "Technical Reference" +weight: 2 +--- diff --git a/docs/go.mod b/docs/go.mod index 5231a53..d264c45 100644 --- a/docs/go.mod +++ b/docs/go.mod @@ -1,3 +1,5 @@ module github.com/gesellix/bose-soundtouch/docs go 1.22.0 + +require github.com/imfing/hextra v0.12.3 // indirect diff --git a/docs/go.sum b/docs/go.sum new file mode 100644 index 0000000..afa8680 --- /dev/null +++ b/docs/go.sum @@ -0,0 +1,2 @@ +github.com/imfing/hextra v0.12.3 h1:DZHY2rUWYteyzjlHi9r4n7Bb5e2Q+6LXe4C1Dqn0ZjM= +github.com/imfing/hextra v0.12.3/go.mod h1:vi+yhpq8YPp/aghvJlNKVnJKcPJ/VyAEcfC1BSV9ARo= diff --git a/docs/hugo.toml b/docs/hugo.toml index 2565c3d..62b154b 100644 --- a/docs/hugo.toml +++ b/docs/hugo.toml @@ -4,6 +4,7 @@ title = "AfterTouch" enableRobotsTXT = true enableGitInfo = true +disablePathToLower = true [module] [module.hugoVersion] @@ -24,6 +25,14 @@ enableGitInfo = true displayUpdatedDate = true dateFormat = "January 2, 2006" + [params.search] + enable = true + type = "flexsearch" + + [params.search.flexsearch] + index = "content" + tokenize = "forward" + [params.navbar] displayTitle = true displayLogo = false diff --git a/docs/layouts/_default/_markup/render-link.html b/docs/layouts/_default/_markup/render-link.html new file mode 100644 index 0000000..643e356 --- /dev/null +++ b/docs/layouts/_default/_markup/render-link.html @@ -0,0 +1,18 @@ +{{- /* + Render hook: strip .md extension from internal links so that links + written as [foo](OTHER-PAGE.md) in Markdown source resolve to the + Hugo page URL instead of a raw .md path (which returns 404). + + This replaces the jekyll-relative-links behaviour from the old Jekyll + site without requiring changes to any content files. +*/ -}} +{{- $dest := .Destination -}} +{{- $isAbs := or (strings.HasPrefix $dest "http://") (strings.HasPrefix $dest "https://") (strings.HasPrefix $dest "//") -}} +{{- if and (not $isAbs) (strings.HasSuffix $dest ".md") -}} + {{- $dest = strings.TrimSuffix ".md" $dest -}} +{{- end -}} +{{ .Text | safeHTML }} +{{- /* Whitespace trimmed intentionally */ -}}