doc: Doc improvements

updated few setup items as per jira KRKNWK18136. Signed-off-by: Anna Wojdylo <[email protected]>
nrfconnect · Dec 13, 2023 · 42ed33d · 42ed33d
1 parent 0070909
commit 42ed33d
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 49 deletions.
diff --git a/doc/setting_up_sidewalk_environment/setting_up_sdk.rst b/doc/setting_up_sidewalk_environment/setting_up_sdk.rst
@@ -42,16 +42,16 @@ Follow these steps to download the Sidewalk application for the nRF Connect SDK:
 
    Make sure the manifest path points to :file:`west.yml` inside the :file:`nrf` directory:
 
-      .. code-block:: console
+   .. code-block:: console
 
-         $ west manifest --path
-         /path-to-ncs-folder/nrf/west.yml
+      $ west manifest --path
+      /path-to-ncs-folder/nrf/west.yml
 
    In case your manifest path points to a different file, use the following command:
 
-      .. code-block:: console
+   .. code-block:: console
 
-         $ west config manifest.path nrf
+      $ west config manifest.path nrf
 
 #. Enable the Sidewalk group filter for west.
 
@@ -63,7 +63,7 @@ Follow these steps to download the Sidewalk application for the nRF Connect SDK:
 
    .. code-block:: console
 
-      $ west list | grep sidewalk
+      $ west list sidewalk
       sidewalk     sidewalk                     <sidewalk_revision> https://github.com/nrfconnect/sdk-sidewalk
 
 #. Update all repositories:
@@ -113,11 +113,6 @@ Follow these steps to download the Sidewalk application for the nRF Connect SDK:
 
       $ git clone --branch v1.14.4 https://github.com/nrfconnect/sdk-sidewalk.git sidewalk
 
-   .. note::
-
-      This method works for Sidewalk revisions up to ``v1.14.5-dev1``.
-      For later versions and for the ``main`` branch, follow the steps in :ref:`dk_building_app_in_nrf_manifest`.
-
 #. Install Python requirements for Sidewalk.
 
    .. code-block:: console

diff --git a/doc/setting_up_sidewalk_environment/setting_up_sidewalk_product.rst b/doc/setting_up_sidewalk_environment/setting_up_sidewalk_product.rst
@@ -8,13 +8,12 @@ To complete the set up of your Sidewalk product, you have to generate provisioni
 Preconditions
 *************
 
-Before creating a Sidewalk provisioning file, you have to:
-
- * Create an AWS account
- * Set up an AWS user with permissions to create resources
- * Set up user's AWS credentials file on your local machine
- * Complete the `Amazon Sidewalk IoT Prerequisites`_ instructions
+Before you create a Sidewalk provisioning file, you need to complete the `Amazon Sidewalk IoT Prerequisites`_ chapter.
+The instructions include:
 
+ * Creating an AWS account
+ * Setting up an AWS user with permissions to create resources
+ * Setting up user's AWS credentials file on your local machine
 
 Provisioning generation
 ***********************
@@ -46,53 +45,77 @@ Provisioning generation
 
 #. Run device provisioning scripts:
 
-   a. Set up Python virtual environment for the provisioning tools:
-
       .. tabs::
 
          .. tab:: Linux
 
-            .. code-block:: console
+            a. Set up Python virtual environment for the provisioning tools:
+
+               .. code-block:: console
+
+                  python3 -m pip install --user virtualenv
+                  python3 -m virtualenv sample-app-env
+                  source sample-app-env/bin/activate
+                  python3 -m pip install --upgrade pip
+                  python3 -m pip install -r requirements.txt
+                  python3 -m pip install pyjwt -t ./ApplicationServerDeployment/lambda/authLibs
+
+            #. Run the device provisioning scripts:
+
+               .. code-block:: console
+
+                  python3 EdgeDeviceProvisioning/provision_sidewalk_end_device.py
+
+               You should see the following output:
+
+               .. code-block:: console
 
-               python3 -m pip install --user virtualenv
-               python3 -m virtualenv sample-app-env
-               source sample-app-env/bin/activate
-               python3 -m pip install --upgrade pip
-               python3 -m pip install -r requirements.txt
-               python3 -m pip install pyjwt -t ./ApplicationServerDeployment/lambda/authLibs
+                  INFO:root:Status: 200
+                  INFO:root:Saving wireless device to file
+                  INFO:root:Generating MFG by calling provision.py
+                  INFO:root:  Generating MFG.hex for Nordic
+                  INFO:root:Done!
+
+            #. Exit the Python virtual environment:
+
+               .. code-block:: console
+
+                  deactivate
 
          .. tab:: Windows
-
-            .. code-block:: console
 
-               py -m pip install --user virtualenv
-               py -m virtualenv sample-app-env
-               sample-app-env\Scripts\activate.bat
-               py -m pip install --upgrade pip
-               py -m pip install -r requirements.txt
-               py -m pip install pyjwt -t ./ApplicationServerDeployment/lambda/authLibs
+            a. Set up Python virtual environment for the provisioning tools:
 
-   #. Run the device provisioning scripts:
+               .. code-block:: console
 
-      .. code-block:: console
-   
-         python3 EdgeDeviceProvisioning/provision_sidewalk_end_device.py
+                  py -m pip install --user virtualenv
+                  py -m virtualenv sample-app-env
+                  sample-app-env\Scripts\activate.bat
+                  py -m pip install --upgrade pip
+                  py -m pip install -r requirements.txt
+                  py -m pip install pyjwt -t ./ApplicationServerDeployment/lambda/authLibs
 
-      You should see the following output:
+            #. Run the device provisioning scripts:
 
-      .. code-block:: console
+               .. code-block:: console
 
-         INFO:root:Status: 200
-         INFO:root:Saving wireless device to file
-         INFO:root:Generating MFG by calling provision.py
-         INFO:root:  Generating MFG.hex for Nordic
-         INFO:root:Done!
+                  py EdgeDeviceProvisioning/provision_sidewalk_end_device.py
 
-   #. Exit the Python virtual environment:
+               You should see the following output:
 
-      .. code-block:: console
+               .. code-block:: console
+
+                  INFO:root:Status: 200
+                  INFO:root:Saving wireless device to file
+                  INFO:root:Generating MFG by calling provision.py
+                  INFO:root:  Generating MFG.hex for Nordic
+                  INFO:root:Done!
+
+            #. Exit the Python virtual environment:
+
+               .. code-block:: console
 
-         deactivate
+                  deactivate
 
 #. Flash the :file:`Nordic_MFG.hex` file.
 
@@ -121,7 +144,7 @@ Provisioning generation
 
          cd EdgeDeviceProvisioning/DeviceProfile_102d750c-e4d0-4e10-8742-ea3698429ca9/WirelessDevice_5153dd3a-c78f-4e9e-9d8c-3d84fabb8911
 
-   #. Flash the :file:`Nordic_MFG.hex` file with the provisioning data: 
+   #. Flash the :file:`Nordic_MFG.hex` file with the provisioning data:
 
       .. code-block:: console