SWPROT-8953: doc: Add reference to UnifySDK online doc

Align to ver_1.7 github pages just deployed

Note in later change some of those files may be deduplicated

Origin: SiliconLabsSoftware#36
Signed-off-by: Philippe Coval <[email protected]>

Author: rzr

doc/getting_started.md

@@ -1,5 +1,16 @@
 # Running Unify on Raspberry Pi
 
+
+Note: For reference documentation please refer to
+[UnifySDK documentation](
+https://siliconlabs.github.io/UnifySDK/doc/getting_started
+)
+
+WARNING: The following chapters may be oudated,
+they are still here until the new release of UnifySDK.
+In the future, Z-Wave parts will be more isolated and the rest deduplicated.
+
+
 The Unify Host SDK targets our reference platform, a Raspberry Pi 4 (RPi4).
 It is therefore recommended to set up a RPi4 for evaluating the full set of functionalities.
 
@@ -21,7 +32,8 @@ pi@raspberrypi:~ $ sudo apt install mosquitto
 ```
 
 For more information regarding logging and configuration of eg. the Mosquitto
-broker, see the [Unify Host SDK User Guide](unify_readme_user.md).
+broker, see the 
+[Unify SDK User Guide](https://siliconlabs.github.io/UnifySDK/doc/unify_readme_user).
 
 ```{toctree}
 ---
@@ -36,7 +48,7 @@ unify_readme_user.md
 
 ## How to install packages
 
-The Unify Host SDK distribution targets the reference platform Debian Bookworm
+The Unify SDK distribution targets the reference platform Debian Bookworm
 platform. Binary Debian packages are provided with the SDK and they are
 available in a Zip file eg. unify_x.y.z_arm64.zip on
 [Unify's GitHub release page](https://github.com/SiliconLabs/UnifySDK/releases).
@@ -125,16 +137,3 @@ hidden:
 Getting Started with the Unify Framework <getting_started_unify_sdk.md>
 ```
 
-## Multiprotocol Setup
-
-If you are interested in setting up multiprotocol CPC-based applications
-see the [Multiprotocol Setup](getting_started_multiprotocol_cpc.md) page.
-
-```{toctree}
----
-maxdepth: 1
-titlesonly:
-hidden:
----
-getting_started_multiprotocol_cpc.md
-```

doc/getting_started_as_developer.md

@@ -1,18 +1,27 @@
 # Getting Started as a Developer
 
-```{toctree}
----
-maxdepth: 2
-hidden:
----
-./readme_developer.md
-```
 
-The [Unify Developer Guide](readme_developer.md) contains a lot of useful information for Unify developers. 
+Note: For reference documentation please refer to
+[UnifySDK documentation](
+https://siliconlabs.github.io/UnifySDK/doc/getting_started_as_developer
+)
 
-The [Unify Build Guide](readme_building.md) is the best starting point for working with the source code.
+WARNING: The following chapters may be oudated,
+they are still here until the new release of UnifySDK.
+In the future, Z-Wave parts will be more isolated and the rest deduplicated.
 
-The [Unify User Guide](unify_readme_user.md) contains helpful tips on debugging within Unify.
+
+The
+[Unify Developer Guide](https://siliconlabs.github.io/UnifySDK/doc/readme_developer)
+contains a lot of useful information for Unify developers. 
+
+The 
+[Unify Build Guide](https://siliconlabs.github.io/UnifySDK/doc/readme_building)
+is the best starting point for working with the source code.
+
+The
+[Unify User Guide](https://siliconlabs.github.io/UnifySDK/doc/unify_readme_user)
+contains helpful tips on debugging within Unify.
 
 ## Development Platform Recommendations
 
@@ -22,16 +31,22 @@ System requirements for flash, RAM, and dependencies are listed at [here](system
 
 ## Developing IoT Services
 
-The IoT or cloud connector must use UCL (MQTT) to communicate with the other components of Unify. See [How to Develop an IoT service](how_to_develop_an_iot_service.md) Unify uses MQTT to communicate among each component using the Mosquitto MQTT broker. UCL is the format of the MQTT messages. The [Unify Framework Specification](./unify_specifications/index.rst) contains the definitions for UCL.
+The IoT or cloud connector must use UCL (MQTT) to communicate with the other components of Unify. See [How to Develop an IoT service](how_to_develop_an_iot_service.md) Unify uses MQTT to communicate among each component using the Mosquitto MQTT broker. UCL is the format of the MQTT messages. 
+The
+[Unify Specifications](https://siliconlabs.github.io/UnifySDK/doc/unify_specifications)
+contains the definitions for UCL.
 
-Also see <a href="../reference_ucl_mqtt/index.html">UCL MQTT API</a>
+Also see 
+[UCL MQTT API](https://siliconlabs.github.io/UnifySDK/reference_ucl_mqtt")
 
 ## Developing protocol controllers
 
-See [How to Develop a Protocol Controller](how_to_develop_a_protocol_controller.rst) 
+See
+[how to develop Protocol Controller](https://siliconlabs.github.io/UnifySDK/doc/how_to_develop_a_protocol_controller)
 
 The attribute mapper helps to translate protocol commands to UCL MQTT messages.
-See [How to write UAM files](how_to_write_uam_files.md)
+See 
+[How to write UAM files](https://siliconlabs.github.io/UnifySDK/doc/how_to_write_uam_files)
 
 ## Extend UCL clusters
 

doc/getting_started_unify.md

@@ -1,5 +1,16 @@
 # Getting Started with Unify
 
+
+Note: For reference documentation please refer to
+[UnifySDK documentation](
+https://siliconlabs.github.io/UnifySDK/doc/getting_started
+)
+
+WARNING: The following chapters may be oudated,
+they are still here until the new release of UnifySDK.
+In the future, Z-Wave parts will be more isolated and the rest deduplicated.
+
+
 ## Introduction
 
 Unify SDK is a software framework that simplifies the developer experience, removing difficult parts of network control and network management as it relates to gateway and hub development in IoT applications. It can also provide Matter bridge functionality to other protocols that do not natively run matter.
@@ -10,32 +21,12 @@ Unify SDK is a software framework that simplifies the developer experience, remo
 
 - At least one of the following, supported wireless radios is connected to the RPi4 via USB:
   - [Z-Wave module](https://www.silabs.com/wireless/z-wave) flashed with Z-Wave - NCP Serial API Controller.
-  - [Zigbee module](https://www.silabs.com/wireless/zigbee) EFR32MG2X/EFR32xG22 running NCP for Zigbee or RCP for Multiprotocol
-  - [Bluetooth module](https://www.silabs.com/wireless/bluetooth) EFR32xG22 running NCP Firmware for AoXPC
-
 
 The following are the ways to get started with Unify..
 
-1) Use [Portable Runtime](portable_runtime/readme_user.md)
+1) Use [UnifySDK Portable Runtime](https://siliconlabs.github.io/UnifySDK/doc/portable_runtime/readme_user)
 for quick demo with Unify IoT gateway running on Windows, MacOS or Linux desktop.
 
-```{toctree}
----
-maxdepth: 1
-titlesonly:
-hidden:
----
-portable_runtime/readme_user.md
-```
-
 2) Use [Unify on Raspberry Pi](getting_started.md)
 for complete hands-on of Unify IoT gateway.
 
-```{toctree}
----
-maxdepth: 1
-titlesonly:
-hidden:
----
-getting_started.md
-```

doc/getting_started_unify_sdk.md

@@ -1,28 +1,36 @@
 # Unify Framework Getting Started
 
+
+Note: For reference documentation please refer to
+[UnifySDK documentation](
+https://siliconlabs.github.io/UnifySDK/doc/getting_started_unify_sdk
+)
+
+WARNING: The following chapters may be oudated,
+they are still here until the new release of UnifySDK.
+In the future, Z-Wave parts will be more isolated and the rest deduplicated.
+
+
 ## Setup base system
 
 Unify Framework has a number of service applications which enables different basic
 functionality. For unlocking all features of the Unify Framework, install the Debian
 packages of the applications below.
-It is recommended to use the Developer GUI for controlling the Unify Framework IoT Protocol Controllers such as `ZPC`,
-`ZigPC` or `AoXPC`.
+It is recommended to use the Developer GUI for controlling the Unify Framework IoT Protocol Controllers such as `ZPC`.
 
 For installation steps refer to the [](how-to-install) section.
 
-1. [Provisioning List (UPVL) User's Guide](../applications/upvl/readme_user.md).
-2. [Group Manager Service (GMS) User's Guide](../applications/gms/readme_user.md).
-3. [Name and Location service (NAL) User's Guide](../applications/nal/readme_user.md).
-4. [OTA Image Provider User's Guide](../applications/image_provider/readme_user.md).
-5. [Developer GUI User's Guide](../applications/dev_ui/dev_gui/readme_user.md).
+1. [Provisioning List (UPVL) User's Guide](https://siliconlabs.github.io/UnifySDK/applications/upvl/readme_user)
+2. [Group Manager Service (GMS) User's Guide](https://siliconlabs.github.io/UnifySDK/applications/gms/readme_user).
+3. [Name and Location service (NAL) User's Guide](https://siliconlabs.github.io/UnifySDK/applications/nal/readme_user).
+4. [OTA Image Provider User's Guide](https://siliconlabs.github.io/UnifySDK/applications/image_provider/readme_user).
+5. [Developer GUI User's Guide](https://siliconlabs.github.io/UnifySDK/applications/dev_ui/dev_gui/readme_user).
 
 ## Choose an IoT protocol
 
 For including an IoT protocol stack, you need to install and setup at least one protocol controller.
 
 - [](zpc)
-- [](zigpc)
-- [](aoxpc)
 
 (zpc)=
 
@@ -39,35 +47,6 @@ provide the USB path for the Z-Wave module at the configuration steps.
 A more in depth getting started guide specifically for the `ZPC` is
 [ZPC User's Guide](../applications/zpc/readme_user.md).
 
-(zigpc)=
-
-### Zigbee Protocol Controller (ZigPC)
-
-**Prerequisite**: Required hardware for using the `ZigPC` is a [Zigbee module](https://www.silabs.com/wireless/zigbee) which could be EFR32MG12/EFR32xG22
-running NCP or CPC Firmware for Zigbee.
-
-The `ZigPC` enables the Unify Framework to control Zigbee devices. Starting quickly
-can be done by simply installing the `uic-zigpc` Debian package and configuring
-the USB device at the configuration step. After installing, the protocol
-controller should be started automatically as a systemd service.
-
-For more information on getting started with the `ZigPC` is placed in
-[ZigPC User's Guide](../applications/zigpc/readme_user.md).
-
-(aoxpc)=
-
-### Bluetooth Angle of Arrival/Departure Protocol Controller (AoXPC)
-
-**Prerequisite**: Required hardware for using the `AoXPC` is a [Bluetooth module](https://www.silabs.com/wireless/bluetooth)
-EFR32xG22 running NCP Firmware for AoXPC.
-
-Lastly of the protocol controllers the above approach can again be used for the
-`AoXPC`. Installing `uic-aoxpc`, going through configuration steps and it should
-be running.
-
-For more information on getting started with the `AoXPC` is found in
-[AoXPC User Guide](../applications/aox/applications/aoxpc/readme_user.md).
-
 ### Evaluation after Installation
 
 Once all Unify Framework Applications are installed and configured, one can evaluate the system via the Unify Framework Developer GUI.
@@ -78,4 +57,6 @@ After a reboot the Unify Framework Developer GUI can be accessed from a browser
 _Note_ that the Unify Framework Developer GUI needs TCP access to the port 3080 and 1337
 on the Raspberry Pi.
 
-See the [Dev-GUI manual](../applications/dev_ui/dev_gui/readme_user.md) for more information about using this interface.
+See the
+[Dev-GUI manual](https://siliconlabs.github.io/UnifySDK/applications/dev_ui/dev_gui/readme_user)
+for more information about using this interface.

doc/how_to_develop_an_iot_service.md

@@ -1,5 +1,16 @@
 # How To Make an IoT Service
 
+
+Note: For reference documentation please refer to
+[UnifySDK documentation](
+https://siliconlabs.github.io/UnifySDK/doc/how_to_develop_an_iot_service
+)
+
+WARNING: The following chapters may be oudated,
+they are still here until the new release of UnifySDK.
+In the future, Z-Wave parts will be more isolated and the rest deduplicated.
+
+
 To build an IoT Service from scratch, it is recommended to follow the steps
 below. IoT Services come in many forms, and exact steps will depend on the
 detailed requirements of the IoT Service.
@@ -20,16 +31,17 @@ detailed requirements of the IoT Service.
 3. Discover nodes using MQTT topics. Discovering nodes and resources that can be
    displayed or manipulated is fundamental to any IoT Service. This is achieved
    by subscribing to particular MQTT topics. See the Service Discovery chapter
-   of the [Unify Specification](./unify_specifications/index.rst).
+   of the 
+   [Unify Specifications](https://siliconlabs.github.io/UnifySDK/doc/unify_specifications)
 4. Implement Network Management. If the IoT Service needs to do network
    management, consider which operations are needed and implement them as
    described in the Network Management chapter of the
-   [Unify Specification](./unify_specifications/index.rst).
+   [Unify Specifications](https://siliconlabs.github.io/UnifySDK/doc/unify_specifications)
 5. Interact with nodes using MQTT topics. Interacting with the nodes by either
    reading out status or controlling their state is fundamental to most IoT
    services. Subscribe and publish to the relevant MQTT topics as described in
    the Application Level Control chapter of the
-   [Unify Specification](./unify_specifications/index.rst).
+   [Unify Specifications](https://siliconlabs.github.io/UnifySDK/doc/unify_specifications)
 6. Consider re-using appropriate shared components from the Unify Framework codebase.
    A valuable feature of Unify is the common components shared by many modules
    of the SDK. Code reuse saves both development time and offers IoT Service

doc/introduction.md

@@ -26,7 +26,6 @@ self
 maxdepth: 2
 hidden:
 ---
-./UnifySDK.md
 ./unify_framework_services.md
 ```
 
@@ -36,7 +35,6 @@ maxdepth: 3
 hidden:
 ---
 ./protocol_controllers.md
-./unify_iot_services.md
 ```
 
 ```{toctree}
@@ -55,26 +53,27 @@ maxdepth: 2
 hidden:
 titlesonly:
 ---
-Unify Specifications <unify_specifications/index.rst>
 ./system_requirements.md
 standards/known-abbreviations.md
 ./license.md
 ```
 
 
 
-This documentation is for the [latest release of the Unify Host SDK](https://github.com/SiliconLabs/UnifySDK/releases/latest).
+This documentation is for the [latest release of the Unify SDK](https://github.com/SiliconLabs/UnifySDK/releases/latest).
 
-* The Silicon Labs Unify Host SDK source code may be found at
+* The Silicon Labs Unify SDK source code may be found at
   <https://github.com/SiliconLabs/UnifySDK>
 * Binary packages for Raspberry Pi 4 (Raspbian 12, Debian Bookworm 64-bit) can be found
   here <https://github.com/SiliconLabs/UnifySDK/releases>
 
-**Use [Portable Runtime](portable_runtime/readme_user.md) for a quick demo with Unify**
+**Use
+[UnifySDK Portable Runtime](https://siliconlabs.github.io/UnifySDK/doc/portable_runtime/readme_user)
+for a quick demo with Unify**
 
 ## Overview
 
-Unify SDK is a software framework that simplifies the developer experience, removing difficult parts of network control and network management as it relates to gateway and hub development in IoT applications. It can also provide Matter bridge functionality to other protocols that do not natively run matter.
+Unify is a software framework that simplifies the developer experience, removing difficult parts of network control and network management as it relates to gateway and hub development in IoT applications. Unify SDK natively supports Z-Wave protocol, and also provides an example code to showcase Matter bridge functionality to Z-Wave and Custom protocols that do not run Matter.
 
 Unify SDK is developed as an open, modular, and portable architecture based on ubiquitous lightweight MQTT technology. The software framework is designed and developed on Linux. It provides an extensible set of software features to enable IoT wireless connectivity in gateways, multiprotocol scalability and application processor-based end products. Unify SDK simplifies development and ongoing software maintenance for IoT gateways and application processor-based end devices.
 
@@ -91,13 +90,16 @@ has created a single repository for important customer software needs on a Linux
 gateway. We've aggregated software from multiple repositories and simplified the
 distribution to enhance ease of use and accessibility.
 
-The Unify Host SDK contains:
+The Unify Ecosystem contains:
 
 * The Unify Framework - A powerful IoT gateway framework that can support multiple wireless protocols.
-* Protocol Controllers that implement various wireless protocols.
-* Multiprotocol Host Software - A collection of host software for simultaneously
-  running multiple protocol stacks on the host.
-  Using a single radio co-processor, you can run Zigbee, OpenThread, and Bluetooth.
+* A Z-Wave protocol Controller that implement wireless Z-Wave protocol.
+* Current software solution can also be leveraged to use proprietary(custom) Protocol Controllers.
+* Emulation of end device for better dev experience.
+
+**Refer
+[how to develop Protocol Controller](https://siliconlabs.github.io/UnifySDK/doc/how_to_develop_a_protocol_controller)
+for adding proprietary(custom) Protocol Contoller to Unify Ecosystem**
 
 Here is a component view along with further detailed descriptions below.
 
@@ -113,16 +115,7 @@ Here is a component view along with further detailed descriptions below.
 The Unify Framework has support for:
 
   [![Z-Wave](assets/img/Z-Wave_logo.png)](../applications/zpc/readme_user.md)
-  [![Zigbee](assets/img/Zigbee_logo.png)](../applications/zigpc/readme_user.md)
-  [![Matter](assets/img/matter_logo.png)](https://siliconlabs.github.io/matter/latest/unify/index.html)
-  [![Bluetooth AoX](assets/img/Bluetooth_logo.png)](../applications/aox/applications/aoxpc/readme_user.md)
-
-Further details can be found on the [Unify Framework introduction page](UnifySDK.md).
-
-## Multiprotocol 
-
-The Unify Host SDK contains support for running Zigbee, OpenThread, and Bluetooth on a
-Linux host, using only a single low-cost Radio Co-Processor (RCP) chip from Silicon Labs.
-This system allows for running multiple protocols simultaneously using the same RCP.
 
-Further details can be found on the [Multiprotocol Host Software page](multiprotocol.md).
+Further details can be found on the 
+[Unify Framework introduction page](https://siliconlabs.github.io/UnifySDK/doc/UnifySDK)
+.