Skip to content

Commit 530cd58

Browse files
divipillairlubos
authored andcommitted
doc: Post 3.5.0-preview1 doc updates
Post 3.5.0-preview1 doc updates. Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
1 parent 292cbd6 commit 530cd58

29 files changed

Lines changed: 733 additions & 114 deletions

doc/nrf/app_dev/programming.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Selecting west runner
2929

3030
Starting with the |NCS| v3.0.0, all Nordic Semiconductor :ref:`boards <app_boards>` are using the `nRF Util`_ as the default runner for the ``west flash`` command.
3131
This change ensures that the programming process is consistent across all boards.
32-
See the :ref:`build system section in the v3.0.0 migration guide <migration_3.0_recommended>` for more information.
32+
See the `build system section in the v3.0.0 migration notes <migration_notes_3.0_recommended_>`_ for more information.
3333

3434
.. note::
3535

doc/nrf/dev_model_and_contributions/code_base.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,16 +156,16 @@ All releases are accompanied by their respective :ref:`release_notes`.
156156
+================================+======================================================================================================================================+
157157
| ``MAJOR`` | Introduces a large number of substantial changes across the board. |
158158
| | Major version number is increased rarely. |
159-
| | Major releases are always accompanied by a :ref:`migration guide <migration_guides>`. |
159+
| | Major releases are always accompanied by a :ref:`migration notes <migration_guides>`. |
160160
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
161161
| ``MINOR`` | Introduces one or more new functionalities. |
162162
| | Version number is increased every time a minor release is cut. |
163-
| | Minor releases are the default types of an |NCS| release and usually are accompanied by a :ref:`migration guide <migration_guides>`. |
163+
| | Minor releases are the default types of an |NCS| release and usually are accompanied by a :ref:`migration notes <migration_guides>`. |
164164
| | The new functionalities may break existing APIs. |
165165
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
166166
| ``PATCH`` | Introduces bug fixes or minor changes to the existing functionalities. |
167167
| | Patch releases only address functional issues and do not introduce new functionalities. |
168-
| | Patch releases do not come with :ref:`migration guide <migration_guides>`. |
168+
| | Patch releases do not come with :ref:`migration notes <migration_guides>`. |
169169
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
170170
| ``MAJOR.MINOR.99`` | The ``99`` added at the end of the version number indicates that the version string is a point in between two releases. |
171171
| | Such version does not belong to a release and corresponds to the current state of development. |

doc/nrf/links.txt

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
.. _`ncs-example-application`: https://github.com/nrfconnect/ncs-example-application
8686
.. _`manifest group filter`: https://github.com/nrfconnect/sdk-nrf/blob/20f40501f69bc9bfd2b321704917da1769411936/west.yml#L42
8787
.. _`Zephyr commit 8dc3f8`: https://github.com/nrfconnect/sdk-zephyr/commit/8dc3f856229ce083c956aa301c31a23e65bd8cd8
88-
.. _`hwmv2 conversion script`: https://github.com/nrfconnect/sdk-zephyr/blob/main/scripts/utils/board_v1_to_v2.py
88+
.. _`hwmv2 conversion script`: https://github.com/nrfconnect/sdk-zephyr/blob/v4.0.99-ncs1/scripts/utils/board_v1_to_v2.py
8989
.. _`sdk-zephyr west build patch`: https://github.com/nrfconnect/sdk-zephyr/blob/1a5d3b4a4ff98a33222856526afdf9c089b96d2b/scripts/west_commands/build.py#L585-L598
9090
.. _`nRF52840 DK board.cmake`: https://github.com/nrfconnect/sdk-zephyr/blob/main/boards/nordic/nrf52840dk/board.cmake
9191

@@ -1133,24 +1133,24 @@
11331133
.. _`LwM2M carrier library changelog for v1.9.1`: https://nrfconnectdocs.nordicsemi.com/ncs/1.9.1/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html
11341134
.. _`LwM2M carrier library changelog for v1.9.0`: https://nrfconnectdocs.nordicsemi.com/ncs/1.9.0/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html
11351135

1136-
.. _`Migration guide for nRF Connect SDK v3.4.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.4.html
1137-
.. _`Migration guide for nRF Connect SDK v3.3.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.3.html
1138-
.. _`Migration guide for nRF Connect SDK v3.2.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.2.html
1139-
.. _`Migration guide for nRF Connect SDK v3.1.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.1.html
1140-
.. _`Migration guide for nRF Connect SDK v3.0.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.0.html
1141-
.. _`Migration guide for nRF Connect SDK v2.9.0-nRF54H20-1`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nRF54H20-1.html
1142-
.. _`Migration guide for nRF Connect SDK v2.9.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.9.html
1143-
.. _`Migration guide for nRF Connect SDK v2.8.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.8.html
1144-
.. _`Migration guide for nRF Connect SDK v2.7.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.7.html
1145-
.. _`Migration guide for nRF Connect SDK v2.6.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.6.html
1146-
.. _`Migration guide for nRF Connect SDK v2.5.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.5.html
1147-
.. _`Migration guide for nRF Connect SDK v2.0.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.html
1136+
.. _`Migration notes for nRF Connect SDK v3.4.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.4.html
1137+
.. _`Migration notes for nRF Connect SDK v3.3.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.3.html
1138+
.. _`Migration notes for nRF Connect SDK v3.2.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.2.html
1139+
.. _`Migration notes for nRF Connect SDK v3.1.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.1.html
1140+
.. _`Migration notes for nRF Connect SDK v3.0.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.0.html
1141+
.. _`Migration notes for nRF Connect SDK v2.9.0-nRF54H20-1`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nRF54H20-1.html
1142+
.. _`Migration notes for nRF Connect SDK v2.9.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.9.html
1143+
.. _`Migration notes for nRF Connect SDK v2.8.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.8.html
1144+
.. _`Migration notes for nRF Connect SDK v2.7.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.7.html
1145+
.. _`Migration notes for nRF Connect SDK v2.6.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.6.html
1146+
.. _`Migration notes for nRF Connect SDK v2.5.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.5.html
1147+
.. _`Migration notes for nRF Connect SDK v2.0.0`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.html
11481148

11491149
.. _`Migrating from Partition Manager to devicetree (DTS)`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_partitions.html
11501150
.. _`Migration from SUIT to IronSide SE for the nRF54H20 SoC`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_3.1_54h_suit_ironside.html
11511151
.. _`Migrating nRF54H20 SoC BICR from DTS to JSON`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_bicr_nRF54H20.html
11521152
.. _`Migrating from multi-image builds to sysbuild`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_sysbuild.html
1153-
.. _`Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.html
1153+
.. _`Migration notes for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.html
11541154
.. _`Migration notes for nRF Connect SDK v2.7.99-cs2 and the nRF54H20 DK`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.html
11551155
.. _`Migration notes for nRF Connect SDK v2.7.99-cs1 and the nRF54H20 DK`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.html
11561156
.. _`Migration notes for nRF Connect SDK v2.7.0 for nRF54H20 DK users`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.html
@@ -1161,6 +1161,7 @@
11611161
.. _`Migrating from Secure Partition Manager to Trusted Firmware-M`: https://nrfconnectdocs.nordicsemi.com/ncs/2.0.0/nrf/ug_tfm.html#migrating_from_secure_partition_manager_to_trusted_firmware-m
11621162

11631163
.. _`migration_guide_3.3_fp_locator_tag`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.3.html#fast_pair_locator_tag_sample
1164+
.. _`migration_notes_3.0_recommended`: https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/releases_and_maturity/migration/migration_guide_3.0.html#migration-3-0-recommended
11641165

11651166
.. _`Matter weather station application from the v2.1.1`: https://nrfconnectdocs.nordicsemi.com/ncs/2.1.1/nrf/applications/matter_weather_station/README.html
11661167

doc/nrf/protocols/matter/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ For a full list of |NCS| and Matter versions, view the following table:
115115
.. important::
116116
For Matter over Thread samples, starting from |NCS| v2.6.0, the default cryptography API is Arm PSA Crypto API instead of Mbed TLS `mbedtls_` API, which was used in earlier versions.
117117
To :ref:`inherit Thread certification <ug_matter_device_certification_reqs_dependent>` from Nordic Semiconductor, you must use the PSA Crypto APIs.
118-
See the :ref:`migration guide <migration_2.6>` to learn about all changes if you are migrating from an earlier version of the |NCS|.
118+
See the `migration notes <Migration notes for nRF Connect SDK v2.6.0_>`_ to learn about all changes if you are migrating from an earlier version of the |NCS|.
119119

120120
For more information about Matter compatibility, see :ref:`ug_matter_overview_dev_model_support` and :ref:`supported Matter features per SoC <software_maturity_protocol_matter>`.
121121

doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ Migrating to the current hardware model
99
:local:
1010
:depth: 2
1111

12-
.. note::
13-
This migration guide is deprecated and will be removed in the future |NCS| release.
14-
1512
The *hardware model* refers to how SoCs and boards are named, defined, and used.
1613
Starting with |NCS| version 2.7.0, this model has been completely updated.
1714

doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.4.99-cs3_to_2.7_application.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ Devicetree
224224
+-----------------------------+------------------------------------------------------+
225225
| ``nordic,bellboard-cpusec`` | Use node label ``cpusec_bellboard``. |
226226
+-----------------------------+------------------------------------------------------+
227-
| ``nordic,tdd-etr-buffer`` | To be replaced in a later version of NCS. |
227+
| ``nordic,tdd-etr-buffer`` | To be replaced in a later version of |NCS|. |
228228
+-----------------------------+------------------------------------------------------+
229229
| ``nrf,hsfll`` | Use node label ``cpuapp_hsfll`` or ``cpurad_hsfll``. |
230230
+-----------------------------+------------------------------------------------------+
@@ -526,7 +526,7 @@ Matter
526526

527527
.. toggle::
528528

529-
With the inheritance of Zephyr's :ref:`sysbuild in the |NCS| <configuration_system_overview_sysbuild>`, some changes are provided to the Matter samples and applications:
529+
With the inheritance of Zephyr's :ref:`sysbuild in the nRF Connect SDK <configuration_system_overview_sysbuild>`, some changes are provided to the Matter samples and applications:
530530

531531
* :kconfig:option:`CONFIG_CHIP_FACTORY_DATA_BUILD` Kconfig option is deprecated and you need to use the :kconfig:option:`SB_CONFIG_MATTER_FACTORY_DATA_GENERATE` Kconfig option instead to enable or disable creating the factory data set during building a Matter sample.
532532
To enable factory data support on your device, you still need to set the :kconfig:option:`CONFIG_CHIP_FACTORY_DATA` to ``y``.
@@ -647,7 +647,7 @@ Applications using build types
647647

648648
For applications using child images:
649649

650-
* With the inheritance of Zephyr's :ref:`sysbuild in the |NCS| <configuration_system_overview_sysbuild>`, the multi-image builds are deprecated.
650+
* With the inheritance of Zephyr's :ref:`sysbuild in the nRF Connect SDK <configuration_system_overview_sysbuild>`, the multi-image builds are deprecated.
651651
If your application uses parent and child images, it is recommended to migrate your application to sysbuild before the multi-image builds are removed in one of the upcoming |NCS| releases.
652652
See :ref:`child_parent_to_sysbuild_migration`.
653653
See the :ref:`documentation in Zephyr <zephyr:sysbuild>` for more information about sysbuild.

doc/nrf/releases_and_maturity/migration_guides.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _migration_guides:
22

3-
Migration guides
3+
Migration notes
44
################
55

66
The |NCS| provides migration notes for all :ref:`major and minor releases <dm-revisions>` to assist user's transition from the previous release.
@@ -43,7 +43,7 @@ Migration notes are also provided for major functionality updates.
4343
.. toctree::
4444
:maxdepth: 1
4545
:glob:
46-
:caption: General migration guides
46+
:caption: General migration notes
4747

4848
migration/migration_sysbuild
4949
migration/migration_partitions

doc/nrf/releases_and_maturity/release_notes.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ This page is included only in the latest documentation, because it might contain
2121
:caption: Subpages:
2222

2323
releases/release-notes-changelog
24+
releases/release-notes-3.5.0-preview1
2425
releases/release-notes-3.3.1
2526
releases/release-notes-3.3.0
2627
releases/release-notes-3.3.0-preview3

doc/nrf/releases_and_maturity/releases/release-notes-2.6.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ See `known issues for nRF Connect SDK v2.6.0`_ for the list of issues valid for
167167
Migration notes
168168
***************
169169

170-
See the `Migration guide for nRF Connect SDK v2.6.0`_ for the changes required or recommended when migrating your application from |NCS| v2.5.0 to |NCS| v2.6.0.
170+
See the `Migration notes for nRF Connect SDK v2.6.0`_ for the changes required or recommended when migrating your application from |NCS| v2.5.0 to |NCS| v2.6.0.
171171

172172
.. _ncs_release_notes_260_changelog:
173173

doc/nrf/releases_and_maturity/releases/release-notes-2.6.99-cs2.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Documentation
146146
* Added:
147147

148148
* The :ref:`ug_nrf54h` section.
149-
* The `Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`_ section.
149+
* The Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users section.
150150

151151
* Updated the table listing the :ref:`boards included in sdk-zephyr <app_boards_names_zephyr>` with the nRF54H20 DK board.
152152

0 commit comments

Comments
 (0)