diff --git a/docs/app.config.ts b/docs/app.config.ts index bd0c510..e8b66f6 100644 --- a/docs/app.config.ts +++ b/docs/app.config.ts @@ -1,6 +1,6 @@ export default defineAppConfig({ docus: { - title: 'YASSI', + title: 'πŸ”Š Yassi', description: 'HomeAssistant: Yet another Samsung soundbar integration', image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png', socials: { @@ -28,7 +28,7 @@ export default defineAppConfig({ fluid: true }, header: { - logo: true, + logo: false, showLinkIcon: true, exclude: [], fluid: true diff --git a/docs/content/0.index.md b/docs/content/0.index.md index a10eb2b..8ae69c3 100644 --- a/docs/content/0.index.md +++ b/docs/content/0.index.md @@ -5,24 +5,19 @@ title: "YASSI" --- cta: - Why another HomeAssistant integration? - - #why-another-integration + - /first-things-first/why-another-integration secondary: - Open on GitHub β†’ - - https://github.com/nuxtlabs/docus -snippet: - - Custom Components - - "- input selection" - - "- soundmode selection" - - "- eq-preset selection" - - "- woofer settings" - - "- other cool things" + - https://github.com/samuelspagl/ha_samsung_soundbar --- #title -Yassi +Yassi - Yet another Samsung Soundbar integration #description -Yet another Samsung soundbar integration for HomeAssistant +**YASSI** is a **HomeAssistant** integration for **Samsung Soundbars**. It enhances control, and adds features like equalizer settings. Install it via HACS or manually. Kudos to the original idea by @PiotrMachowski and @thierryBourbon! πŸŽΆπŸ”Š + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=samuelspagl&repository=ha_samsung_soundbar&category=integration) :: ::card-grid @@ -34,36 +29,42 @@ Quick-Start #default ::card #title - Getting Started. + ❓ Why another integration? #description - Go, Go, Go... Here you will find information on "How to install / configure". + Weather you thought about it or not, here is the answer ;).

- :button-link[click here]{href="/getting-started"} + :button-link[click here]{href="/first-things-first/why-another-integration"} :: ::card #title - Features + πŸš€ Getting Started + #description + Go, Go, Go... Here you will find information on "How to install / configure". +
+
+ :button-link[click here]{href="/first-things-first/getting-started"} + :: + + ::card + #title + ✨ Features #description Many cool features are awaiting your eyes to see ✨.

:button-link[click here]{href="/features"} :: -:: - -## Why another integration - -The current Samsung Soundbar Integration by @PiotrMachowski / @thierryBourbon are already pretty cool. -But I wanted it to appear as a device, and base the Foundation on the `pysmartthings` python package. - -Additionally, I wanted full control over the *Soundmode* and more. So I tried out a few things with the API, -and found that also the **Subwoofer** as well as the **Equalizer** are controllable. - -I created a new wrapper around the `pysmartthings.DeviceEntity` specifically set up for a Soundbar, and this -is the Result. - -I hope to integrate also controls for **surround speaker** as well as **Space-Fit Sound**, but as these features -are not documented... ;) \ No newline at end of file + ::card + #title + βš™οΈ SmartThings API related information + #description + If you want to know some background information on how equalizer support and + other things were implemented, this is your section. +
+
+ :button-link[click here]{href="/features"} + :: +:: \ No newline at end of file diff --git a/docs/content/1.first-things-first/0.why-another-integration.md b/docs/content/1.first-things-first/0.why-another-integration.md new file mode 100644 index 0000000..56188b0 --- /dev/null +++ b/docs/content/1.first-things-first/0.why-another-integration.md @@ -0,0 +1,13 @@ +# ❓ Why another integration + +The current Samsung Soundbar Integration by @PiotrMachowski / @thierryBourbon are already pretty cool. +But I wanted it to appear as a device, and base the Foundation on the `pysmartthings` python package. + +Additionally, I wanted full control over the *Soundmode* and more. So I tried out a few things with the API, +and found that also the **Subwoofer** as well as the **Equalizer** are controllable. + +I created a new wrapper around the `pysmartthings.DeviceEntity` specifically set up for a Soundbar, and this +is the Result. + +I hope to integrate also controls for **surround speaker** as well as **Space-Fit Sound**, but as these features +are not documented... ;) \ No newline at end of file diff --git a/docs/content/1.getting-started/0.index.md b/docs/content/1.first-things-first/1.getting-started.md similarity index 100% rename from docs/content/1.getting-started/0.index.md rename to docs/content/1.first-things-first/1.getting-started.md diff --git a/docs/content/1.first-things-first/2.issues-and-other-things.md b/docs/content/1.first-things-first/2.issues-and-other-things.md new file mode 100644 index 0000000..1111b59 --- /dev/null +++ b/docs/content/1.first-things-first/2.issues-and-other-things.md @@ -0,0 +1,17 @@ +# ‼️ Issues and other things + +As the creator of this personal and fun project, I am thrilled to see people using it. While I won’t always have immediate availability to address every request, I’ll do my best to fix issues and implement features. Thanks a lot in advance! πŸ™Œ + +Here are some best practices to help me help you: + +1. 🐞 GitHub Issues: For any issues or bugs, please submit them via GitHub Issues. ([πŸ”— click here](https://github.com/samuelspagl/ha_samsung_soundbar/issues/new)) +2. πŸ“‹ Provide Details: Include essential information: + - HomeAssistant OS Version + - Samsung Soundbar Model + - Other Relevant Details +3. πŸŽ‡ Icons for Fun: + - πŸ“¦ = Feature Request + - πŸ› = Bug Report + - ❓ = General Questions + +Let’s collaborate to enhance your soundbar experience! πŸŽΆπŸ”Š \ No newline at end of file diff --git a/docs/content/2.features/0.index.md b/docs/content/2.features/0.index.md index e12def8..623092a 100644 --- a/docs/content/2.features/0.index.md +++ b/docs/content/2.features/0.index.md @@ -1,4 +1,4 @@ -# Features Overview +# ✨ Features Overview Yassi allows you to retrieve and set the status of various features on your Samsung Soundbar. Below is a breakdown of capabilities organized by entity type. @@ -41,4 +41,4 @@ Yassi allows you to retrieve and set the status of various features on your Sams |-------------------|----------------|-----------------| | Media Cover Art | display | Read | -This table format provides a clear and concise view of what Yassi can do with your Samsung Soundbar, making it easier to understand and configure. +Hopefully this format provides a clear and concise view of what Yassi can do with your Samsung Soundbar, making it easier to understand and configure.