doc: new sidewalk setup doc review

doc/conf.py

@@ -31,6 +31,7 @@
     'sphinx_tabs.tabs',
     'sphinx_togglebutton',
     'sphinxcontrib.plantuml',
+    'sphinx_copybutton'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

doc/includes/include_building_and_running.txt

@@ -3,7 +3,7 @@ This sample can be found under :file:`samples/sid_end_device`.
 .. note::
    Before you flash your Sidewalk sample, make sure you have completed the following:
 
-      * You have set up the Sidewalk repository using the standalone west.yml configuration as described in the :ref:`setting_up_sdk` section.
+      * You have set up the Sidewalk repository using the standalone :file:`west.yml` configuration as described in the :ref:`setting_up_sdk` section.
       * You provisioned your device during the :ref:`setting_up_sidewalk_prototype`.
 
    This step needs to be completed only once.

doc/index.rst

@@ -7,7 +7,7 @@
 
    Be aware, that by downloading and including the Sidewalk repository, you accept the above-mentioned license.
 
-   Due to these restrictions, Sidewalk is now managed through its own west.yml configuration, separate from the nRF Connect SDK manifest.
+   Due to these restrictions, Sidewalk is now managed through its own :file:`west.yml` configuration, separate from the nRF Connect SDK manifest.
    All information regarding completing the setup is included in this guide, so ensure you follow it in order.
 
 Welcome to the nRF Connect SDK - Amazon Sidewalk

doc/links.rst

@@ -25,6 +25,8 @@
 .. _Installing the nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/installation/install_ncs.html
 .. _Trusted storage: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/libraries/security/trusted_storage.html
 .. _Hardware flash write protection: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/libraries/security/bootloader/fprotect.html
+.. _West: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/develop/west/index.html
+.. _Zephyr's Hello World: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/zephyr/samples/hello_world/README.html
 
 .. ncs fixed links(do not update them)
 
@@ -46,6 +48,9 @@
 .. _nRF Command Line Tools: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Command-Line-Tools/Download#infotabs
 .. _DevZone DFU guide: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/software/posts/ncs-dfu#ble_testing
 .. _Board Configurator: https://docs.nordicsemi.com/bundle/nrf-connect-board-configurator/page/index.html
+.. _nRF Connect for VS Code: https://www.nordicsemi.com/Products/Development-tools/nRF-Connect-for-VS-Code
+.. _nRF Util: https://www.nordicsemi.com/Products/Development-tools/nRF-Util
+.. _nRF Connect SDK Add-ons: https://nrfconnect.github.io/ncs-app-index/
 
 .. github.com
 

doc/releases_and_migration.rst

@@ -23,6 +23,6 @@ See information about the latest release notes and the available migration guide
    :glob:
    :caption: Migration guides:
 
+   releases_and_migration/migration_guide_addon_v010.rst
    releases_and_migration/migration_guide_v280.rst
    releases_and_migration/migration_guide_v260.rst
-   releases_and_migration/migration_guide_addon_v010.rst

doc/releases_and_migration/migration_guide_addon_v010.rst

@@ -1,101 +1,98 @@
 .. _migration_guide_addon_v010:
 
-Migration Guide for moving to Sidewalk Add-on 
-############################################
+Migration guide for moving to Sidewalk Add-on
+#############################################
 
-This guide explains how to migrate your Sidewalk development environment from using the NCS manifest to the new standalone west.yml setup.
+Starting with the v3.0.0 release of the `nRF Connect SDK`_, a new standalone :file:`west.yaml` setup has been introduced.
+Follow this guide to migrate your Sidewalk development environment from using the nRF Connect SDK manifest setup.
 
 Overview
-========
+********
 
-The Sidewalk repository has been moved out of the NCS manifest into its own west.yml configuration. This change provides more flexibility and better control over the Sidewalk development environment. The Sidewalk release cycle will be detached from NCS, allowing for faster releases of new libraries on stable versions of NCS. The Sidewalk repository is now visible in the NCS add-on index repository, which enables an alternative setup method using the VSCode NRF Connect add-on.
+The Sidewalk repository has been moved out of the NCS manifest into its own :file:`west.yml` configuration.
+This change provides more flexibility and better control over the Sidewalk development environment.
+The Sidewalk release cycle is now separate from the nRF Connect SDK, allowing for faster releases of new libraries.
+You can now find Amazon Sidewalk under the `nRF Connect SDK Add-ons`_ index.
+This solution enables an alternative setup method using the `nRF Connect for VS Code`_.
 
 Prerequisites
-============
-
-Before starting the migration, ensure you have:
-
-* Git installed on your system
-* Python 3.8 or later installed
-* The west tool installed
-* nrfutil installed
-
-Migration Steps
-=============
+*************
 
-1. Initialize Sidewalk Repository
--------------------------------
+Before you begin the migration process, you must have the following tools installed:
 
-There are three ways to initialize the Sidewalk repository:
+* Git
+* Python 3.8 or later
+* The `west`_ tool
+* `nRF Util`_
 
-.. tabs::
+Migration steps
+***************
 
-   .. tab:: Option 1: Direct Initialization (Recommended)
+To successfully migrate to Amazon Sidewalk Add-on you must choose the migration method.
+If you wish to set up a clean repository, follow one of the methods outlined on the :ref:`setting_up_sdk_sidewalk_repository` page.
+If you already have an nRF Connect SDK setup with Sidewalk and wish to migrate, you must complete the following steps:
 
-      .. code-block:: console
+#. Remove the :file:`.west` directory to clean the west configuration.
 
-         # Initialize west with the remote manifest
-         west init -m https://github.com/nrfconnect/sdk-sidewalk
+   .. code-block:: console
 
-   .. tab:: Option 2: Manual Clone and Initialize
+      rm -rf .west
 
-      .. code-block:: console
+#. Checkout and pull main branch in the Sidewalk repository.
 
-         # Clone the Sidewalk repository into sidewalk directory
-         git clone https://github.com/nordicsemiconductor/sidewalk.git sidewalk
-         # Initialize west with local manifest
-         west init -l sidewalk
+   .. code-block:: console
 
-   .. tab:: Option 3: Clean Existing Configuration
+      cd sidewalk
+      git checkout main
+      git pull origin main
+      cd ..
 
-      If you already have an NCS setup with Sidewalk, you need to remove the existing west configuration first:
+#. Initialize west with local manifest.
 
-      .. code-block:: console
+   .. code-block:: console
 
-         # Remove the .west directory to clean the west configuration
-         rm -rf .west
-         # Checkout and pull main branch in Sidewalk repository
-         cd sidewalk
-         git checkout main
-         git pull origin main
-         cd ..
-         # Initialize west with local manifest
-         west init -l sidewalk
+      west init -l sidewalk
 
-2. Update Repositories
----------------------
+#. Update all repositories, by running the following command:
 
    .. code-block:: console
 
-      # Update all repositories
       west update
 
-3. Update Toolchain and Install Dependencies
-------------------------------------------
+   Depending on your connection, the update might take some time.
+
+#. Execute the following commands to get the toolchain hash and download the necessary toolchain:
 
    .. code-block:: console
 
-      # Get the toolchain hash and download it
       nrf/scripts/toolchain.py
       nrfutil toolchain install --ncs-version $(nrf/scripts/toolchain.py --ncs-version)
-      # Install Python dependencies for nRF and Zephyr
+
+#. Install the required Python packages for both nRF Connect SDK and Zephyr by running the following commands:
+
+   .. code-block:: console
+
       pip install -r nrf/scripts/requirements.txt
       pip install -r zephyr/scripts/requirements.txt
-      # Install Sidewalk Python requirements
+
+#. Install Python dependencies.
+
+   .. code-block:: console
+
       pip install -r requirements.txt
 
 Verification
-===========
+************
 
-To verify your migration was successful:
+Verify if your migration was successful by completing the following steps:
+
+1. Ensure that all repositories are properly cloned.
 
-1. Check that all repositories are properly cloned:
-
    .. code-block:: console
 
       west list
 
-   Expected output should show all required repositories with their paths and revisions. For example:
+   Expected output should show all required repositories with their paths and revisions.
 
    .. code-block:: console
 
@@ -104,54 +101,58 @@ To verify your migration was successful:
       manifest               sidewalk                HEAD
       ...
 
-   Invalid output would be:
+   An invalid output might include:
+
    * Empty list
    * Missing repositories
    * Error messages
-   * "Not found" status for any repository
+   * The ``Not found`` status for any of the repositories
 
-2. Verify the build process:
-
-   .. code-block:: console
+#. Check the build process.
+
+   .. parsed-literal::
+      :class: highlight
+
+      west build -b *board_target* samples/sid_end_device
+
+   This will build the Sidewalk end device sample application.
+   If the build succeeds, your migration was successful.
 
-      west build -b nrf54l15dk/nrf54l15/cpuapp samples/sid_end_device
+Troubleshooting
+***************
 
-   This will build the Sidewalk end device sample application. If the build succeeds, your migration was successful.
+See the list of common issues and resolutions during the migration process.
 
-Common Issues and Solutions
-=========================
+Repository conflicts
+====================
 
-1. Repository Conflicts
-----------------------
+If you encounter repository conflicts, do the following:
 
-   If you encounter repository conflicts during the migration:
+#. Remove the :file:`.west` directory.
 
    .. code-block:: console
 
-      # Remove the .west directory
       rm -rf .west
-      # Reinitialize west
+
+#. Reinitialize west.
+
+   .. code-block:: console
+
       west init -l sidewalk
-      # Update repositories
-      west update
 
-2. Build Errors
---------------
+#. Update all repositories.
 
-   If you encounter build errors:
+   .. code-block:: console
 
-   * Ensure all dependencies are installed
-   * Check that the NCS environment is properly sourced
-   * Verify that you're using the correct board target
-   * Try building the Zephyr hello world sample to verify your basic build environment:
-
-     .. code-block:: console
+      west update
 
-        west build -b nrf54l15dk/nrf54l15/cpuapp zephyr/samples/basic/hello_world
+Build errors
+============
 
-Additional Resources
-==================
+If you encounter build errors, ensure the following:
 
-* :ref:`setting_up_environment`
-* :ref:`samples_list`
-* :ref:`compatibility_matrix` 
+ * All dependencies are installed.
+ * NCS environment is sourced correctly.
+ * You are using the correct board target.
+ * Your build evironment is functioning correctly.
+   To do this, build the `Zephyr's Hello World`_ sample.

doc/requirements-doc.txt

@@ -9,6 +9,7 @@ sphinx-ncs-theme==0.6.2
 sphinx-rtd-theme==0.5.2
 sphinx-tabs==3.1.0
 sphinx-togglebutton==0.3.2
+sphinx-copybutton==0.5.2
 sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-devhelp==1.0.2
 sphinxcontrib-htmlhelp==2.0.1