doc: pre-release doc updates

fixed links, pdk occurences. other small changes Signed-off-by: Anna Wojdylo <[email protected]>
nrfconnect · Nov 4, 2024 · 9be5ec7 · 9be5ec7
1 parent ae200c2
commit 9be5ec7
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 48 deletions.
diff --git a/doc/compatibility_matrix.rst b/doc/compatibility_matrix.rst
@@ -15,27 +15,41 @@ The following table demonstrates the compatibility between the nRF Connect SDK a
      - Amazon specification (Sidewalk MCU SDK version)
      - Supported platforms
      - Amazon qualification status
-   * - v1.14.3
-     - v2.3.0
+   * - ---
+     - v2.8.0
+     - v1.17.0
+     - * `nRF52840 DK`_
+       * `nRF5340 DK`_
+       * `nRF54L15 DK`_
+     - Planned
+   * - ---
+     - v2.7.0
+     - v1.16.2
+     - * `nRF52840 DK`_
+       * `nRF5340 DK`_
+       * nRF54L15 PDK (experimental)
+     - Planned
+   * - ---
+     - v2.6.0
+     - v1.16.2
+     - * `nRF52840 DK`_
+       * `nRF5340 DK`_
+     - Qualified/approved
+   * - ---
+     - v2.5.0 `*`
      - v1.14
      - * `nRF52840 DK`_
+       * `nRF5340 DK`_
      - Qualified/approved
    * - v1.14.4
      - v2.4.0
      - v1.14
      - * `nRF52840 DK`_
      - Qualified/approved
-   * - ---
-     - v2.5.0 `*`
+   * - v1.14.3
+     - v2.3.0
      - v1.14
      - * `nRF52840 DK`_
-       * `nRF5340 DK`_
      - Qualified/approved
-   * - ---
-     - v2.6.0
-     - v1.16.2
-     - * `nRF52840 DK`_
-       * `nRF5340 DK`_
-     - Planned
 
 `*` From the v2.5.0 release, Amazon Sidewalk is a part of the nRF Connect SDK.
diff --git a/doc/links.rst b/doc/links.rst
@@ -2,38 +2,40 @@
 
 .. ncs links (all links need to be updated manually **right before** the targeted release)
 
-.. _nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/index.html
-.. _nrf52840 DK: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/config_and_build/board_support/board_names.html
-.. _nrf5340 DK: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/config_and_build/board_support/board_names.html
-.. _Thingy53: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/config_and_build/board_support/board_names.html
-.. _nRF54L15 PDK: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/config_and_build/board_support/board_names.html
+.. _nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/index.html
+.. _nrf52840 DK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
+.. _nrf5340 DK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
+.. _Thingy53: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
+.. _nRF54L15 DK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/board_support/board_names.html
 .. _Getting started with nRF52 Series: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/gsg_guides/nrf52_gs.html
 .. _Getting started with nRF53 Series: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/gsg_guides/nrf5340_gs.html
-.. _Getting started with nRF54L Series: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/device_guides/working_with_nrf/nrf54l/nrf54l15_gs.html
-.. _nRF Connect SDK Getting started: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/installation.html
-.. _nRF52840dk: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/zephyr/boards/nordic/nrf52840dk/doc/index.html
-.. _nrf5340dk: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/zephyr/boards/nordic/nrf5340dk/doc/index.html
-.. _thingy53_nrf5340: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/zephyr/boards/nordic/thingy53/doc/index.html
-.. _nrf54l15pdk: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/zephyr/boards/nordic/nrf54l15pdk/doc/index.html
-.. _Building and programming an application: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/config_and_build/programming.html
-.. _Testing and debugging an application: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/test_and_optimize.html
-.. _Bootloader and DFU solutions for NCS: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/config_and_build/bootloaders/index.html
-.. _Zephyr SMP Server: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/zephyr/services/device_mgmt/ota.html#smp_server
-.. _Zephyr SMP Server sample: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/zephyr/samples/subsys/mgmt/mcumgr/smp_svr/README.html
-.. _Zephyr State Machine Framework: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/zephyr/services/smf/index.html
-.. _NCS testing applications: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/test_and_optimize.html
-.. _Installing the nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/installation/install_ncs.html
+.. _Getting started with nRF54L Series: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/gsg_guides/gsg_other.html
+.. _nRF Connect SDK Getting started: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/installation.html
+.. _nRF52840dk: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/nrf52840dk/doc/index.html
+.. _nrf5340dk: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/nrf5340dk/doc/index.html
+.. _thingy53_nrf5340: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/thingy53/doc/index.html
+.. _nrf54l15dk: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/boards/nordic/nrf54l15dk/doc/index.html
+.. _Building and programming an application: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/programming.html
+.. _Testing and debugging an application: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/test_and_optimize.html
+.. _Bootloader and DFU solutions for NCS: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/config_and_build/bootloaders/index.html
+.. _Zephyr SMP Server: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/services/device_mgmt/ota.html#smp_server
+.. _Zephyr SMP Server sample: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/samples/subsys/mgmt/mcumgr/smp_svr/README.html
+.. _Zephyr State Machine Framework: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/zephyr/services/smf/index.html
+.. _NCS testing applications: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/test_and_optimize.html
+.. _Installing the nRF Connect SDK: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/installation/install_ncs.html
 .. _Board Configurator: https://docs.nordicsemi.com/bundle/nrf-connect-board-configurator/page/index.html
-.. _Trusted storage: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/security/trusted_storage.html
-.. _Hardware flash write protection: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/security/bootloader/fprotect.html
+.. _Trusted storage: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/libraries/security/trusted_storage.html
+.. _Hardware flash write protection: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/libraries/security/bootloader/fprotect.html
 
 .. ncs fixed links(do not update them)
 
 
+.. _Release notes for the nRF Connect SDK v2.8.0: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/releases_and_maturity/releases/release-notes-2.8.0.html
 .. _Release notes for the nRF Connect SDK v2.7.0: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/releases_and_maturity/releases/release-notes-2.7.0.html
 .. _Release notes and limitations for the nRF Connect SDK v2.6.99-cs1: https://docs.nordicsemi.com/bundle/ncs-2.6.99-cs1/page/nrf/releases_and_maturity/releases/release-notes-2.6.99-cs1.html
 .. _Release notes for the nRF Connect SDK v2.6.0: https://docs.nordicsemi.com/bundle/ncs-2.6.0/page/nrf/releases_and_maturity/releases/release-notes-2.6.0.html
 .. _Release notes for the nRF Connect SDK v2.5.0: https://docs.nordicsemi.com/bundle/ncs-2.5.0/page/nrf/releases_and_maturity/releases/release-notes-2.5.0.html
+.. _Known issues for the nRF Connect SDK for the v2.8.0: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/releases_and_maturity/known_issues.html
 .. _Known issues for the nRF Connect SDK for the v2.7.0: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/releases_and_maturity/known_issues.html
 .. _Known issues for the nRF Connect SDK for the v2.6.0: https://docs.nordicsemi.com/bundle/ncs-2.6.0/page/nrf/releases_and_maturity/known_issues.html
 .. _Known issues for the nRF Connect SDK for the v2.5.0: https://docs.nordicsemi.com/bundle/ncs-2.5.0/page/nrf/releases_and_maturity/known_issues.html

diff --git a/doc/releases_and_migration.rst b/doc/releases_and_migration.rst
@@ -10,6 +10,7 @@ See information about the latest release notes and the available migration guide
    :glob:
    :caption: Release notes:
 
+   releases_and_migration/release_notes_v280.rst
    releases_and_migration/release_notes_v270.rst
    releases_and_migration/release_notes_v2699cs1.rst
    releases_and_migration/release_notes_v260.rst

diff --git a/doc/releases_and_migration/migration_guide_v280.rst b/doc/releases_and_migration/migration_guide_v280.rst
@@ -91,8 +91,8 @@ The version 1.17 of Sidewalk libraries introduces metrics and capability feature
 New end device characteristics
 ==============================
 
-A new characteristic has been added to the :ref:`sidewalk_end_device` configuration. 
-This characteristic includes device type, power source, and qualification ID. 
+A new characteristic has been added to the :ref:`sidewalk_end_device` configuration.
+This characteristic includes device type, power source, and qualification ID.
 To add this information, you must populate the ``dev_ch`` fields in the ``sid_config`` structure before the Sidewalk stack starts.
 
 See the following example of device characteristics:
@@ -116,20 +116,20 @@ See the following example of device characteristics:
 New Sidewalk ID option
 ======================
 
-A new option has been introduced that allows fetching of the Sidewalk ID for the device. 
+A new option has been introduced that allows fetching of the Sidewalk ID for the device.
 This option is functional only after the device has been registered, as the Sidewalk ID is assigned post-registration.
 
 The Sidewalk ID can be retrieved using the ``-gsi`` subcommand of the CLI (DUT) option:
 
 .. code-block:: console
 
-  uart:~$ sid last_status 
+  uart:~$ sid last_status
   [00:00:51.950,347] <inf> sid_cli: Device Is registered, Time Sync Fail, Link status: {BLE: Down, FSK: Down, LoRa: Down}
   uart:~$ sid option -gsi
   [00:00:55.582,641] <inf> sid_cli: sid_option returned 0 (SID_ERROR_NONE); SIDEWALK_ID: BFFFFFABCD
 
 Fixing uplink buffer
 ====================
 
-Upon migration, you can remove the ``pending_message_list`` workaround, as the first uplink message after Link Up payload has been fixed in the v2.8.0 release. 
-For the issue details, see Amazon Sidewalk Known Issues.
+Upon migration, you can remove the ``pending_message_list`` workaround, as the first uplink message after Link Up payload has been fixed in the v2.8.0 release.
+For the issue details, see Amazon Sidewalk section of `Known issues for the nRF Connect SDK for the v2.8.0`_.
diff --git a/doc/releases_and_migration/release_notes_v280.rst b/doc/releases_and_migration/release_notes_v280.rst
@@ -0,0 +1,17 @@
+.. _sidewalk_release_notes_280:
+
+Release notes for Amazon Sidewalk - nRF Connect SDK v2.8.0
+##########################################################
+
+
+For more information about the current Amazon Sidewalk release, refer to the links in the following sections.
+
+Changelog
+*********
+
+See the `Release notes for the nRF Connect SDK v2.8.0`_ release.
+
+Known issues
+************
+
+See `Known issues for the nRF Connect SDK for the v2.8.0`_ release.
diff --git a/doc/samples/samples_list.rst b/doc/samples/samples_list.rst
@@ -11,22 +11,20 @@ The following table demonstrates the variants' configuration for the supported d
 +-----------------------------------+------------------------------------------+--------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
 | Sample variant                    | Description                              | Development kit                | Additional hardware                                                       | Bootloader (in release and debug configs)     | Application overlays      |
 +===================================+==========================================+================================+===========================================================================+===============================================+===========================+
-| :ref:`variant_sidewalk_hello`     | Sample application showing communication | * `nRF52840 DK`_               | * External flash (included in the DK) except `nRF54L15 PDK`_              | * MCUboot - DFU partition in external flash   | * ``overlay-hello.conf``  |
+| :ref:`variant_sidewalk_hello`     | Sample application showing communication | * `nRF52840 DK`_               | * External flash (included in the DK) except `nRF54L15 DK`_               | * MCUboot - DFU partition in external flash   | * ``overlay-hello.conf``  |
 |                                   | over Sidewalk network.                   | * `nRF5340 DK`_                | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK)  | * Application partition size = 956 kB         |                           |
-|                                   |                                          | * `nRF54L15 PDK`_ `*`          |                                                                           |                                               |                           |
+|                                   |                                          | * `nRF54L15 DK`_               |                                                                           |                                               |                           |
 +-----------------------------------+------------------------------------------+--------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
-| :ref:`variant_sensor_monitoring`  | Demo application of Sidewalk protocol    | * `nRF52840 DK`_               | * External flash (included in the DK) except `nRF54L15 PDK`_              | * MCUboot - DFU partition in external flash   | * ``overlay-demo.conf``   |
+| :ref:`variant_sensor_monitoring`  | Demo application of Sidewalk protocol    | * `nRF52840 DK`_               | * External flash (included in the DK) except `nRF54L15 DK`_               | * MCUboot - DFU partition in external flash   | * ``overlay-demo.conf``   |
 |                                   | with  temperature sensor monitoring.     | * `nRF5340 DK`_                | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK)  | * Application partition size = 956 kB         |                           |
 |                                   |                                          | * `Thingy53`_                  |                                                                           |                                               |                           |
-|                                   |                                          | * `nRF54L15 PDK`_ `*`          |                                                                           |                                               |                           |
+|                                   |                                          | * `nRF54L15 DK`_               |                                                                           |                                               |                           |
 +-----------------------------------+------------------------------------------+--------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
-| :ref:`variant_sidewalk_dut`       | Device under test generic application    | * `nRF52840 DK`_               | * External flash (included in the DK) except `nRF54L15 PDK`_              | * MCUboot - DFU partition in external flash   | * ``overlay-dut.conf``    |
+| :ref:`variant_sidewalk_dut`       | Device under test generic application    | * `nRF52840 DK`_               | * External flash (included in the DK) except `nRF54L15 DK`_               | * MCUboot - DFU partition in external flash   | * ``overlay-dut.conf``    |
 |                                   | having activated CLI.                    | * `nRF5340 DK`_                | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK)  | * Application partition size = 956 kB         |                           |
-|                                   |                                          | * `nRF54L15 PDK`_ `*`          |                                                                           |                                               |                           |
+|                                   |                                          | * `nRF54L15 DK`_               |                                                                           |                                               |                           |
 +-----------------------------------+------------------------------------------+--------------------------------+---------------------------------------------------------------------------+-----------------------------------------------+---------------------------+
 
-`*` The `nRF54L15 PDK`_ does not support LoRa and FSK configurations.
-
 .. note::
 
    With the v2.6.0 release of the `nRF Connect SDK`_ a new sample model has been introduced.

diff --git a/doc/samples/sid_end_device.rst b/doc/samples/sid_end_device.rst
@@ -27,10 +27,9 @@ This sample supports the following development kits:
 +--------------------+----------+-------------------+----------------------------------+
 | Thingy53           | PCA20053 | `thingy53`_       | ``thingy53/nrf5340/cpuapp``      |
 +--------------------+----------+-------------------+----------------------------------+
-| nRF54L15 PDK  `*`  | PCA10156 | `nrf54l15pdk`_    | ``nrf54l15pdk/nrf54l15/cpuapp``  |
+| nRF54L15 DK        | PCA10156 | `nrf54l15dk`_     | ``nrf54l15dk/nrf54l15/cpuapp``   |
 +--------------------+----------+-------------------+----------------------------------+
 
-`*` The `nRF54L15 PDK`_ does not support LoRa and FSK configurations.
 
 To run the sample in the Bluetooth LE link mode, you only need the development kit.
 However, if you want to run the sample with LoRa or FSK configuration, you also need the LoRa radio module.