Merge pull request #655 from balena-io-experimental/vipulgupta2048/ad…

…d-docusaurus

Add standard docusaurus-builder docs

.github/ISSUE_TEMPLATE/dac_request.md

@@ -6,7 +6,7 @@ labels: DAC
 assignees: ""
 ---
 
-**Note: please read the [DAC section](https://balena-labs-projects.github.io/balena-sound/audio-interfaces#dac-boards) on our official documentation site before proceeding.**
+**Note: please read the [DAC section](https://balena-sound.pages.dev/audio-interfaces#dac-boards) on our official documentation site before proceeding.**
 
 **Do** open an issue if you:
 

.github/workflows/flowzone.yml

@@ -1,14 +1,15 @@
-
 name: Flowzone
 
 on:
   pull_request:
     types: [opened, synchronize, closed]
     branches: [main, master]
+
   # allow external contributions to use secrets within trusted code
   pull_request_target:
     types: [opened, synchronize, closed]
     branches: [main, master]
+
   workflow_dispatch:
 
 jobs:
@@ -30,13 +31,21 @@ jobs:
 
     with:
       balena_slugs: balenalabs/balenasound
-
-  update-balena-yml:
-    name: Update balena.yml
-    uses: balena-io-experimental/balena.yml-action@main
-    with:
-      # Synchronise the GitHub README with the Balena Hub README
-      sync_readme: true
-      # If pushing a tag to deploy, use the same tag as the version number to display on Balena Hub
-      sync_tag: false
+      cloudflare_website: "balena-sound"
+
+  sync:
+    name: "Synchronize BalenaHub Readme"
+    runs-on: "ubuntu-22.04"
+    needs: [flowzone]
+    steps:
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+
+      - name: Update balena.yml
+        uses: balena-io-experimental/balena.yml-action@main
+        with:
+          # Synchronise the GitHub README with the Balena Hub README
+          sync_readme: true
+          # If pushing a tag to deploy, use the same tag as the version number to display on Balena Hub
+          sync_tag: false
 

CONTRIBUTING.md

@@ -5,7 +5,7 @@ balenaSound was created as a [hack friday](https://www.balena.io/blog/hack-frida
 
 ## Overview
 
-Make sure you checkout our [architecture][../contributing/architecture] guide, which aims to explain how all pieces fit together. It's a good starting point for understanding how we designed and built balenaSound. 
+Make sure you checkout our [architecture][./docs/ARCHITECTURE.md] guide, which aims to explain how all pieces fit together. It's a good starting point for understanding how we designed and built balenaSound. 
 
 Another way to improve how you use and contribute to balenaSound is to take our [masterclasses](https://www.balena.io/docs/learn/more/masterclasses/overview/). Each lesson is a self-contained, deep walk-through on core skills to be successful with your next edge project. Check them out at our [docs](https://www.balena.io/docs/learn/more/masterclasses/overview/).
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Balena Labs Projects
+Copyright (c) 2024 Balena Labs Projects
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -12,11 +12,11 @@
 
 Running this app is as simple as deploying it to a balenaCloud fleet. You can do it in just one click by using the button below:
 
-[![deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balena-labs-projects/balena-sound&defaultDeviceType=raspberry-pi)
+[![deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balena-io-experimental/balena-sound&defaultDeviceType=raspberry-pi)
 
 ## Documentation
 
-Head over to our [docs](https://balena-labs-projects.github.io/balena-sound/) for detailed installation and usage instructions, customization options, and more!
+Head over to our [docs](https://balena-sound.pages.dev) for detailed installation and usage instructions, customization options, and more!
 
 ## Motivation
 
@@ -30,4 +30,4 @@ This project is in active development so if you have any feature requests or iss
 
 ## Getting Help
 
-If you're having any problem, please [raise an issue](https://github.com/balena-labs-projects/balena-sound/issues/new) on GitHub and we will be happy to help.
+If you're having any problem, please [raise an issue](https://github.com/balena-io-experimental/balena-sound/issues/new) on GitHub and we will be happy to help.

balena.yml

@@ -10,12 +10,12 @@ assets:
   repository:
     type: blob.asset
     data:
-      url: 'https://github.com/balena-labs-projects/balena-sound'
+      url: 'https://github.com/balena-io-experimental/balena-sound'
   logo:
     type: blob.asset
     data:
       url: >-
-        https://raw.githubusercontent.com/balena-labs-projects/balena-sound/master/logo.png
+        https://raw.githubusercontent.com/balena-io-experimental/balena-sound/master/logo.png
 data:
   applicationEnvironmentVariables:
     - SOUND_VOLUME: 75

core/audio/balena-sound.pa

@@ -1,4 +1,4 @@
-# See https://github.com/balena-labs-projects/balena-sound/blob/master/ARCHITECTURE.md for details
+# See https://github.com/balena-io-experimental/balena-sound/blob/master/docs/ARCHITECTURE.md for details
 
 # Create balena-sound sinks
 load-module module-null-sink sink_name=balena-sound.input

core/multiroom/client/start.sh

@@ -20,7 +20,7 @@ echo "Starting multi-room client..."
 echo "- balenaSound mode: $MODE"
 echo "- Target snapcast server: $SNAPSERVER"
 
-# Set the snapcast device name for https://github.com/balena-labs-projects/balena-sound/issues/332
+# Set the snapcast device name for https://github.com/balena-io-experimental/balena-sound/issues/332
 if [[ -z $SOUND_DEVICE_NAME ]]; then
     SNAPCAST_CLIENT_ID=$BALENA_DEVICE_UUID
 else

core/sound-supervisor/src/ui/index.html

@@ -32,7 +32,7 @@
               <li class="nav-item navbar-brand">
                 <a
                   class="nav-link active"
-                  href="https://github.com/balena-labs-projects/balena-sound"
+                  href="https://github.com/balena-io-experimental/balena-sound"
                   style="color: white"
                 >
                   <i class="fa fa-github" style="font-size: 150%"></i>
@@ -107,7 +107,7 @@ <h5 class="card-title">
                   <p class="card-text">
                     (Requires internet) Set a custom dtoverlay. See our
                     <a
-                      href="https://balena-labs-projects.github.io/balena-sound/audio-interfaces#dac-boards"
+                      href="https://balena-sound.pages.dev/audio-interfaces#dac-boards"
                       target="__blank"
                       >docs</a
                     >

docker-compose.yml

@@ -37,7 +37,7 @@ services:
     restart: on-failure
 
   # Plugins
-  # -- Additional plugins can be added. See https://balena-labs-projects.github.io/balena-sound/plugins.
+  # -- Additional plugins can be added. See https://balena-sound.pages.dev/plugins
   # -- Remove unwanted plugins as needed
   bluetooth:
     build: ./plugins/bluetooth

docs/01-getting-started.md

@@ -1,14 +1,6 @@
----
-slug: /
+# Getting Started
 
-sidebar_position: 1
-title: Getting Started
-breadcrumbs: false
----
-
-# ![logo](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/balenaSound-logo.png)
-
-# Getting started
+![logo](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/balenaSound-logo.png)
 
 Getting started with balenaSound is as simple as deploying it to a [balenaCloud](https://balena.io/cloud) fleet; no additional configuration is required (unless you're using a DAC HAT).
 We've outlined the installation steps below. If you want a step-by-step tutorial on how to get balenaSound up and running, feel free to check these blog posts:
@@ -40,7 +32,7 @@ One-click deploy is the easiest way to get started with balenaSound as it allows
 
 Click this button to go straight to balenaCloud fleet creation, where balenaSound app will be pre-loaded:
 
-[![balena deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balena-labs-projects/balena-sound&defaultDeviceType=raspberry-pi)
+[![balena deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balena-io-experimental/balena-sound&defaultDeviceType=raspberry-pi)
 
 ### Provision your device
 
@@ -98,4 +90,4 @@ If you are running into issues getting your balenaSound app running, please try
 
 1. Check the [support and troubleshooting guide](support) for common issues and how to resolve them.
 2. Post in the [balenaSound forum](https://forums.balena.io/c/balenalabs/balenasound/85) for help from our growing community.
-3. Create an issue on the [balenaSound GitHub project](https://github.com/balena-labs-projects/balena-sound/issues/new/choose) if you find your issue may be a problem with balenaSound.
+3. Create an issue on the [balenaSound GitHub project](https://github.com/balena-io-experimental/balena-sound/issues/new/choose) if you find your issue may be a problem with balenaSound.

docs/02-usage.md

@@ -65,7 +65,7 @@ balenaSound has been re-designed to easily allow integration with audio streamin
 | Bluetooth       | balena [bluetooth](https://github.com/balenablocks/bluetooth/) and [audio](https://github.com/balenablocks/audio) blocks                                                                                                                                                                        |
 | Soundcard input | Experimental support through the balena [audio](https://github.com/balenablocks/audio) block. Check the [customization](customization#plugins) section to learn how to enable it.                                                                                                               |
 
-If your desired audio source is not supported feel free to [reach out](support#contact-us) and leave us a comment. We've also considerably simplified the process of adding new plugins, so [PR's are welcome](https://github.com/balena-labs-projects/balena-sound/blob/master/CONTRIBUTING.md) too (be be sure to check out our balenaSound [architecture](https://github.com/balena-labs-projects/balena-sound/blob/master/ARCHITECTURE.md) guide)!
+If your desired audio source is not supported feel free to [reach out](support#contact-us) and leave us a comment. We've also considerably simplified the process of adding new plugins, so [PR's are welcome](https://github.com/balena-labs-projects/balena-sound/blob/master/CONTRIBUTING.md) too (be be sure to check out our balenaSound [architecture](https://github.com/balena-labs-projects/balena-sound/blob/master/docs/ARCHITECTURE.md) guide)!
 
 ## Audio interfaces
 

docs/04-plugins.md

@@ -30,8 +30,8 @@ Manual authentication will let you stream audio over the internet from a client
 The following plugins are available to be added to your balenaSound installation:
 
 - UPnP: Universal Plug and Play
-- (Work in progress) Tidal Connect: See [PR #399](https://github.com/balena-labs-projects/balena-sound/pull/399)
-- (Work in progress) Roon Bridge: See [PR #388](https://github.com/balena-labs-projects/balena-sound/pull/388)
+- (Work in progress) Tidal Connect: See [PR #399](https://github.com/balena-io-experimental/balena-sound/pull/399)
+- (Work in progress) Roon Bridge: See [PR #388](https://github.com/balena-io-experimental/balena-sound/pull/388)
 
 Installing these plugins is a more involved process than just deploying the off the shelf version of balenaSound. You'll need to edit the contents of the `docker-compose.yml` file before deploying the app. This means that you won't be able to deploy using the "Deploy with balena" button; you either need to use the [CLI to deploy](https://balena-labs-projects.github.io/balena-sound/getting-started#cli-deploy) or use "Deploy with balena" with your own forked version of the project. If you don't feel comfortable performing these steps or need some help along the way hit us up at our [forums](https://forums.balena.io) and we'll gladly help you out.
 

docs/05-audio-interfaces.md

@@ -2,9 +2,9 @@
 
 If you want to upgrade the sound quality of your balenaSound devices, or if your board has no onboard soundcard, you'll probably want to add an external soundcard. Generally these come in two flavors: **USB soundcards** or **DAC boards**. Both alternatives are widely supported in balenaSound.
 
-Checkout the [customization](customization#general) section to learn how to select which audio interface to use. For a detailed and up to date list of what interfaces are supported on each device check out the audio block [documentation](https://github.com/balenablocks/audio#supported-devices) section.
+Checkout the [customization](https://balena-sound.pages.dev/customization) section to learn how to select which audio interface to use. For a detailed and up to date list of what interfaces are supported on each device check out the audio block [documentation](https://github.com/balenablocks/audio#supported-devices) section.
 
-As a general rule of thumb, onboard and USB soundcards should work out of the box without any configuration, and DACs usually require setting a `dtoverlay`. Read on to learn more about the alternatives. If for any reason you can't get your soundcard to work, feel free to [contact us](./support#contact-us) and we'll gladly help out.
+As a general rule of thumb, onboard and USB soundcards should work out of the box without any configuration, and DACs usually require setting a `dtoverlay`. Read on to learn more about the alternatives. If for any reason you can't get your soundcard to work, feel free to [contact us](https://balena-sound.pages.dev/support#contact-us) and we'll gladly help out.
 
 ## Onboard
 
@@ -25,9 +25,9 @@ balenaSound supports a wide variety of DACs, but in an ever-growing market, chan
 
 Latest versions of balenaOS already ships with drivers for most, if not all, of the DACs available. The testing story, however, is different. It's not possible for us to test all of them individually as it would take an incredible amount of resources. For this reason, we rely on community contributions to help catalogue existing DACs into three categories:
 
-- [Supported DACs](#Supported-DACs): battle-tested, known to work with balenaSound.
-- [Untested DACs](#Untested-DACs): DACs whose drivers are included in balenaOS but haven't been tested with balenaSound (most likely because no balena team member has one).
-- [Unsupported DACs](#Unsupported-DACs): DACs that probably need additional drivers that aren't currently available in balenaOS.
+- [Supported DACs](https://balena-sound.pages.dev/audio-interfaces#Supported-DACs): battle-tested, known to work with balenaSound.
+- [Untested DACs](https://balena-sound.pages.dev/audio-interfaces#Untested-DACs): DACs whose drivers are included in balenaOS but haven't been tested with balenaSound (most likely because no balena team member has one).
+- [Unsupported DACs](https://balena-sound.pages.dev/audio-interfaces#Unsupported-DACs): DACs that probably need additional drivers that aren't currently available in balenaOS.
 
 A curated list for all three categories can be found in the sections below. If you don't find your DAC anywhere, please add a comment to [this](https://github.com/balena-labs-projects/balena-sound/issues/439) GitHub issue and we'll take a look for you.
 
@@ -94,7 +94,7 @@ These are the DACs that are known to work with balenaSound. If you have trouble
 [6]: https://www.hifiberry.com/products/dacplus/
 [7]: https://forums.balena.io/t/no-sound-from-dac/61343/5
 [8]: http://www.inno-maker.com/product/hifi-dac-hat/
-[9]: https://github.com/balena-labs-projects/balena-sound/pull/98
+[9]: https://github.com/balena-io-experimental/balena-sound/pull/98
 [10]: https://allo.com/sparky/miniboss-rpi-zero.html
 [11]: http://www.kumantech.com/kuman-sc07-raspberry-pi-hifi-digi-digital-sound-card-i2s-spdif-optical-fiber-for-raspberry-pi-3-2-model-b-b-sc07_p0041.html
 [12]: https://shop.pimoroni.com/collections/pirate-audio
@@ -121,18 +121,18 @@ These are the DACs that are known to work with balenaSound. If you have trouble
 [33]: https://shop.pimoroni.com/products/pi-digi?variant=33370425994
 [34]: https://www.raspberrypi.org/products/iqaudio-digiamp-plus/
 [35]: https://www.inno-maker.com/product/hifi-amp-hat/
-[36]: https://github.com/balena-labs-projects/balena-sound/issues/385
+[36]: https://github.com/balena-io-experimental/balena-sound/issues/385
 [37]: https://raspiaudio.com/produit/audio
-[38]: https://github.com/balena-labs-projects/balena-sound/issues/355
+[38]: https://github.com/balena-io-experimental/balena-sound/issues/355
 [39]: https://www.audiophonics.fr/fr/dac-et-interfaces-pour-raspberry-pi/audiophonics-i-sabre-dac-es9023-tcxo-raspberry-pi-a-b-20-i2s-p-9978.html
-[40]: https://github.com/balena-labs-projects/balena-sound/issues/345
+[40]: https://github.com/balena-io-experimental/balena-sound/issues/345
 
 ### Untested DACs
 
-An up to date list of untested DACs can be found in [this](https://github.com/balena-labs-projects/balena-sound/issues/439) GitHub issue. If you have one of these DACs and want to help us test it, please post on our [forums](https://forums.balena.io/) and we'll get back to you with instructions. Hopefully, with your assistance, new DACs can be graduated into the supported category!
+An up to date list of untested DACs can be found in [this](https://github.com/balena-io-experimental/balena-sound/issues/439) GitHub issue. If you have one of these DACs and want to help us test it, please post on our [forums](https://forums.balena.io/) and we'll get back to you with instructions. Hopefully, with your assistance, new DACs can be graduated into the supported category!
 
 **Note:** Please **do not** create new GitHub issues for untested DACs unless you've been instructed to do so by our forums support agents.
 
 ### Unsupported DACs
 
-An up to date list of unsupported DACs can be found in [this](https://github.com/balena-labs-projects/balena-sound/issues/439) GitHub issue. Unsupported DACs can be made to work with balenaSound but often will require further investigation and patching balenaOS, so they are best avoided. Please **do** create a new GitHub issue if you are working on adding support or testing an unsupported DAC as that will facilitate discussion with balenaSound developers.
+An up to date list of unsupported DACs can be found in [this](https://github.com/balena-io-experimental/balena-sound/issues/439) GitHub issue. Unsupported DACs can be made to work with balenaSound but often will require further investigation and patching balenaOS, so they are best avoided. Please **do** create a new GitHub issue if you are working on adding support or testing an unsupported DAC as that will facilitate discussion with balenaSound developers.