doc: doc adjustments for v2.7.0 release

adjusted the documentation for 2.7.0 ncs release Signed-off-by: Anna Wojdylo <[email protected]>
ktaborowski · Jun 12, 2024 · fa1c34d · fa1c34d
1 parent eeb119f
commit fa1c34d
Show file tree

Hide file tree

Showing 20 changed files with 606 additions and 394 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -60,5 +60,5 @@
 plantuml = 'java -jar /usr/local/bin/plantuml.jar'
 
 rst_epilog = """
-.. include:: /ncs_links.rst
+.. include:: /links.rst
 """
diff --git a/doc/includes/include_testing_nordic_dfu.txt b/doc/includes/include_testing_nordic_dfu.txt
@@ -1,21 +1,40 @@
-Testing Device Firmware Update (DFU)
-------------------------------------
+Testing Device Firmware Update
+------------------------------
 
-#. To enter the DFU mode, long press **Button 1** on your development kit.
-   This action sets the device in the DFU mode, in which only the `Zephyr SMP Server`_ is running and Sidewalk is not operational.
-   When the application is in the DFU mode, all LEDs flash every 500 ms to signal that the application is waiting for a new image.
+Complete the following steps to test the Device Firmware Update (DFU) on your device:
 
-#. To perform a firmware update, follow the Bluetooth testing steps from the `DevZone DFU guide`_.
-   When the update starts, the LEDs change the pattern to indicate upload in progress.
+.. tabs::
 
-#. To exit the DFU mode, long press **Button 1** again when device is in DFU mode.
-   The device will set the device in the Sidewalk mode.
-   If the update completes successfully, the device will start a new image.
-   After using the DFU mode, the first bootup might take up to 60 seconds.
-   During the image swap the application is silent, meaning that LEDs are not blinking and the console does not output any logs.
-   The application, however, is running, so do not reset the device.
-   In case the update fails, the old image is started instead.
+   .. group-tab:: nRF52 and nRF53 DKs
 
-.. include:: ../../ncs_links.rst
+      #. Enter the DFU mode by long pressing **Button 1** on your development kit.
+         This action sets the device in the DFU mode, in which only the `Zephyr SMP Server`_ is running and Sidewalk is not operational.
+         When the application is in the DFU mode, all LEDs flash every 500 ms to signal that the application is waiting for a new image.
 
-.. _DevZone DFU guide: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/software/posts/ncs-dfu#ble_testing
+      #. To perform a firmware update, follow the Bluetooth testing steps from the `DevZone DFU guide`_.
+         When the update starts, the LEDs change the pattern to indicate upload in progress.
+
+      #. To exit the DFU mode, long press **Button 1** again when device is in DFU mode.
+         The device will set the device in the Sidewalk mode.
+         If the update completes successfully, the device will start a new image.
+         After using the DFU mode, the first bootup might take up to 60 seconds.
+         During the image swap the application is silent, meaning that LEDs are not blinking and the console does not output any logs.
+         The application, however, is running, so do not reset the device.
+         In case the update fails, the old image is started instead.
+
+   .. group-tab:: nRF54 DKs
+
+      #. Enter the DFU mode by long pressing **Button 0** on your development kit.
+         This action sets the device in the DFU mode, in which only the `Zephyr SMP Server`_ is running and Sidewalk is not operational.
+         When the application is in the DFU mode, all LEDs flash every 500 ms to signal that the application is waiting for a new image.
+
+      #. To perform a firmware update, follow the Bluetooth testing steps from the `DevZone DFU guide`_.
+         When the update starts, the LEDs change the pattern to indicate upload in progress.
+
+      #. To exit the DFU mode, long press **Button 0** again when device is in DFU mode.
+         The device will set the device in the Sidewalk mode.
+         If the update completes successfully, the device will start a new image.
+         After using the DFU mode, the first bootup might take up to 60 seconds.
+         During the image swap the application is silent, meaning that LEDs are not blinking and the console does not output any logs.
+         The application, however, is running, so do not reset the device.
+         In case the update fails, the old image is started instead.
diff --git a/doc/includes/include_user_interface_common.txt b/doc/includes/include_user_interface_common.txt
diff --git a/doc/includes/memory_requirement.txt b/doc/includes/memory_requirement.txt
@@ -3,7 +3,7 @@
    .. tab:: nRF52840 DK
 
       The following table lists the total memory requirements for the default variant of the :ref:`Sidewalk_End_device` sample running on the `nRF52840 DK`_.
-      To determine the available space for user extension, it needs to be summarized versus the allocated partition size and its layout.
+      To determine the available space for user extension, it needs to be summarized against the allocated partition size and its layout.
 
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
       | Sample                                                                                                         | MCUboot ROM [kB] | Application ROM [kB] | Factory data [kB] | Settings (Sidewalk) [kB] | Total ROM [kB] | Total RAM [kB] |
@@ -12,15 +12,15 @@
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
       |  :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release)   |      26.33       |        352.07        |         4         |            8             |     390.40     |     89.66      |
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
-      |                :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug)                 |      26.33       |        496.32        |         4         |            8             |     534.65     |     109.91     |
+      |  :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug)                               |      26.33       |        496.32        |         4         |            8             |     534.65     |     109.91     |
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
-      |               :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release)                |      26.33       |        430.45        |         4         |            8             |     468.78     |     105.04     |
+      |  :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release)                             |      26.33       |        430.45        |         4         |            8             |     468.78     |     105.04     |
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
 
    .. tab:: nRF5340 DK
 
       The following table lists the total memory requirements for the default variant of the :ref:`Sidewalk_End_device` sample running on the `nRF5340 DK`_.
-      To determine the available space for user extension, it needs to be summarized versus the allocated partition size and its layout.
+      To determine the available space for user extension, it needs to be summarized against the allocated partition size and its layout.
 
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
       | Sample                                                                                                         | MCUboot ROM [kB] | Application ROM [kB] | Factory data [kB] | Settings (Sidewalk) [kB] | Total ROM [kB] | Total RAM [kB] |
@@ -29,15 +29,15 @@
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
       |  :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release)   |      30.77       |        291.68        |         4         |            8             |     334.45     |     78.46      |
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
-      |                :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug)                 |      30.77       |        435.18        |         4         |            8             |     477.95     |     98.34      |
+      |  :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug)                               |      30.77       |        435.18        |         4         |            8             |     477.95     |     98.34      |
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
-      |               :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release)                |      30.77       |        367.13        |         4         |            8             |     409.90     |     93.64      |
+      |  :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release)                             |      30.77       |        367.13        |         4         |            8             |     409.90     |     93.64      |
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
 
    .. tab:: nRF54L15 PDK
 
       The following table lists the total memory requirements for the default variant of the :ref:`Sidewalk_End_device` sample running on the `nRF54L15 PDK`_.
-      To determine the available space for user extension, it needs to be summarized versus the allocated partition size and its layout.
+      To determine the available space for user extension, it needs to be summarized against the allocated partition size and its layout.
 
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
       | Sample                                                                                                         | MCUboot ROM [kB] | Application ROM [kB] | Factory data [kB] | Settings (Sidewalk) [kB] | Total ROM [kB] | Total RAM [kB] |
@@ -46,7 +46,7 @@
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
       |  :ref:`Hello Sidewalk Bluetooth LE <variant_sidewalk_hello>` (``CONFIG_SIDEWALK_SUBGHZ_SUPPORT=n``, Release)   |      26.03       |        285.67        |         4         |            8             |     323.70     |     83.80      |
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
-      |                :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug)                 |      26.03       |        432.32        |         4         |            8             |     470.35     |     103.99     |
+      |  :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Debug)                               |      26.03       |        432.32        |         4         |            8             |     470.35     |     103.99     |
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
-      |               :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release)                |      26.03       |        361.94        |         4         |            8             |     399.97     |     99.17      |
+      |  :ref:`Hello Sidewalk Bluetooth LE and sub-GHz <variant_sidewalk_hello>` (Release)                             |      26.03       |        361.94        |         4         |            8             |     399.97     |     99.17      |
       +----------------------------------------------------------------------------------------------------------------+------------------+----------------------+-------------------+--------------------------+----------------+----------------+
diff --git a/doc/index.rst b/doc/index.rst
@@ -43,6 +43,5 @@ Browse the content by referring to the following pages:
    setting_up_sidewalk_environment/setting_up_environment.rst
    samples/samples_list.rst
    compatibility_matrix.rst
-   migration_guide.rst
-   sidewalk_release_notes.rst
+   releases_and_migration.rst
    additional_resources.rst