Skip to content

Commit aae9948

Browse files
b-genteivindj-nordic
b-gent
authored and
eivindj-nordic
committed
doc: doc release changes for NCS BM v2.0.0
Release notes and other updates. Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no>
1 parent 9f7209a commit aae9948

9 files changed

Lines changed: 590 additions & 383 deletions

‎doc/nrf-bm/doxygen/mainpage.dox‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
@mainpage nRF Connect SDK Bare Metal option v1.0.99 API documentation
2+
@mainpage nRF Connect SDK Bare Metal option v2.0.0 API documentation
33

44
<a href="topics.html">API Reference</a>
55

‎doc/nrf-bm/install_nrf_bm.rst‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,13 @@ Every |BMlong| release consists of:
5858
The selected region applies to all future SDK and toolchain downloads.
5959
You can later change it in the |VSC| settings.
6060

61-
#. In the next page you will be prompted to **Select SDK type**, click :guilabel:`nRF Connect SDK Bare Metal`.
61+
#. When prompted to **Select SDK type**, click :guilabel:`nRF Connect SDK Bare Metal`.
6262

63-
#. In the next page you will be prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v2.0.0-preview1` marked on the right by the label :guilabel:`Pre-packaged SDKs & Toolchains`.
63+
#. When prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v2.0.0` marked on the right by the label :guilabel:`Pre-packaged SDKs & Toolchains`.
6464

65-
#. In the next page you will be prompted to select a destination for the SDK. The default suggestion is recommended. Then press **Enter**.
66-
This will proceed by installing |BMshort| and the respective Toolchain it requires.
65+
#. When prompted to select a destination for the SDK, the default suggestion is recommended.
66+
Then, press **Enter**.
67+
The installer will proceed to install |BMshort| and the respective toolchain that it requires.
6768

6869
.. group-tab:: GitHub
6970

@@ -100,16 +101,18 @@ Every |BMlong| release consists of:
100101

101102
Complete the following steps to get the |BMshort| code using the |nRFVSC|.
102103

103-
1. In the extension's :guilabel:`Welcome View`, click :guilabel:`Manage SDKs`. A popup window will appear.
104+
1. In the extension's :guilabel:`Welcome View`, click :guilabel:`Manage SDKs`.
105+
A popup window will appear.
104106

105107
#. Click :guilabel:`Install SDK`.
106108

107-
#. In the next page you will be prompted to **Select SDK type**, click :guilabel:`nRF Connect SDK Bare Metal`.
109+
#. When prompted to **Select SDK type**, click :guilabel:`nRF Connect SDK Bare Metal`.
108110

109-
#. In the next page you will be prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v2.0.0-preview1` marked on the right by the label :guilabel:`GitHub`.
111+
#. When prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v2.0.0` marked on the right by the label :guilabel:`GitHub`.
110112

111-
#. In the next page you will be prompted to select a destination for the SDK. The default suggestion is recommended. Then press **Enter**.
112-
This will proceed by installing |BMshort|.
113+
#. When prompted to select a destination for the SDK, the default suggestion is recommended.
114+
Then, press **Enter**.
115+
|BMshort| will now be installed.
113116

114117
Your directory structure should now look similar to this:
115118

‎doc/nrf-bm/links.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,10 @@
121121
.. _`nRF54L15`: https://docs.nordicsemi.com/category/nRF54L15-category
122122
.. _`nRF54L10`: https://docs.nordicsemi.com/category/nRF54L10-category
123123
.. _`nRF54L05`: https://docs.nordicsemi.com/category/nRF54L05-category
124+
.. _`nRF54LM20A`: https://docs.nordicsemi.com/category/nRF54LM20A-category
125+
.. _`nRF54LS05B`: https://docs.nordicsemi.com/category/nRF54LS05B-category
126+
.. _`nRF54LV10A`: https://docs.nordicsemi.com/category/nRF54LV10A-category
127+
124128
.. _`nrfx documentation`: https://docs.nordicsemi.com/bundle/nrfx-apis-latest/page/index.html
125129

126130
.. ### Release notes and migration

‎doc/nrf-bm/release_notes.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ The following is a list of all release notes documents for various releases of t
1010
:caption: Subpages:
1111

1212
release_notes/bm_software_maturity
13-
release_notes/release_notes_changelog
14-
release_notes/release_notes_2.0.0-preview1
13+
release_notes/release_notes_2.0.0
1514
release_notes/release_notes_1.0.0
1615
release_notes/release_notes_0.9.0
1716
release_notes/release_notes_0.8.0

‎doc/nrf-bm/release_notes/bm_software_maturity.rst‎

Lines changed: 31 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -73,28 +73,29 @@ See the following table for more details:
7373

7474
For the certification status of different features in a specific SoC, see its Compatibility Matrix in the `Nordic Semiconductor TechDocs`_.
7575

76-
nRF Devices in scope of |BMshort|
77-
*********************************
76+
Target devices for |BMshort|
77+
****************************
7878

79-
A device is considered supported if at least one sample or component has been demonstrated on it in the SDK, with the software maturity level set to supported.
79+
The following nRF devices are in scope of |BMshort|.
80+
The level of maturity varies per protocol and feature — refer to other tables in this page for more details.
8081

81-
.. list-table:: Device support
82+
.. list-table:: Available devices
8283
:header-rows: 0
8384
:align: center
8485
:widths: auto
8586

8687
* - nRF54L15
87-
- Supported from v1.0.0
88+
- `nRF54L15 DK`_
8889
* - nRF54L10
89-
- Supported from v1.0.0
90+
- `nRF54L15 DK`_
9091
* - nRF54L05
91-
- Supported from v1.0.0
92-
* - nRF54LV10
93-
- Experimental
92+
- `nRF54L15 DK`_
9493
* - nRF54LM20A
95-
- Experimental
94+
- `nRF54LM20 DK`_
9695
* - nRF54LS05B
97-
- Experimental
96+
- `nRF54LS05 DK`_
97+
* - nRF54LV10A
98+
- `nRF54LV10 DK`_
9899

99100
.. note::
100101
Any device not listed is considered out of scope.
@@ -113,23 +114,23 @@ The following table indicates the software maturity levels of the support for ea
113114
- nRF54L15
114115
- nRF54L10
115116
- nRF54L05
116-
- nRF54LV10
117117
- nRF54LM20A
118118
- nRF54LS05B
119+
- nRF54LV10A
119120
* - **Bluetooth®**
120121
- Supported
121122
- Supported
122123
- Supported
123-
- Experimental
124+
- Supported
124125
- Experimental
125126
- Experimental
126127
* - **NFC**
127128
- Supported
128129
- Supported
129130
- Supported
130-
- n/a
131131
- Experimental
132132
- n/a
133+
- n/a
133134
* - **ESB**
134135
- --
135136
- --
@@ -156,27 +157,23 @@ The following table indicates SoftDevice compatibility per SoC:
156157
- nRF54L15
157158
- nRF54L10
158159
- nRF54L05
159-
- nRF54LV10
160160
- nRF54LM20A
161161
- nRF54LS05B
162+
- nRF54LV10A
162163
* - **SoftDevice S115**
163164
- Supported
164165
- Supported
165166
- Supported
166-
- Experimental
167+
- Supported
167168
- Experimental
168169
- Experimental
169170
* - **SoftDevice S145**
170171
- Supported
171172
- Supported
172173
- Supported
174+
- Supported
173175
- Experimental
174176
- Experimental
175-
- Experimental
176-
177-
.. note::
178-
The Experimental status of the S145 SoftDevice refers to its integration in the |BMlong|.
179-
The SoftDevice itself is production-ready.
180177

181178
The following table indicates Bluetooth features supported per SoftDevice:
182179

@@ -220,7 +217,7 @@ The following table indicates Bluetooth features supported per SoftDevice:
220217
For more details on supported Bluetooth features, see the SoftDevice Specification documents:
221218

222219
* `S115 SoftDevice Specification`_
223-
* S145 (Specification not available yet)
220+
* `S145 SoftDevice Specification`_
224221

225222
NFC features support
226223
********************
@@ -236,44 +233,44 @@ The following table indicates the software maturity levels of the support for ea
236233
- nRF54L15
237234
- nRF54L10
238235
- nRF54L05
239-
- nRF54LV10
240236
- nRF54LM20A
241237
- nRF54LS05B
238+
- nRF54LV10A
242239
* - **NFC Type 2 Tag (read-only)**
243240
- Supported
244241
- Supported
245242
- Supported
246-
- n/a
247243
- Experimental
248244
- n/a
245+
- n/a
249246
* - **NFC Type 4 Tag (read/write)**
250247
- Supported
251248
- Supported
252249
- Supported
253-
- n/a
254250
- Experimental
255251
- n/a
252+
- n/a
256253
* - **NDEF encoding and decoding**
257254
- Supported
258255
- Supported
259256
- Supported
260-
- n/a
261257
- Experimental
262258
- n/a
259+
- n/a
263260
* - **NFC Record Type Definition: URI, text**
264261
- Supported
265262
- Supported
266263
- Supported
267-
- n/a
268264
- Experimental
269265
- n/a
266+
- n/a
270267
* - **NFC Connection Handover to Bluetooth carrier, Static and Negotiated Handover**
271268
- Supported
272269
- Supported
273270
- Supported
274-
- n/a
275271
- Experimental
276272
- n/a
273+
- n/a
277274

278275
.. note::
279276
The Experimental status of the nRF54LM20A refers to its integration in the |BMlong|.
@@ -299,27 +296,27 @@ The following table indicates the software maturity levels of the support for ea
299296
- nRF54L15
300297
- nRF54L10
301298
- nRF54L05
302-
- nRF54LV10
303299
- nRF54LM20A
304300
- nRF54LS05B
301+
- nRF54LV10A
305302
* - **Immutable MCUboot as part of build**
306303
- Supported
307304
- Supported
308305
- Supported
309-
- Experimental
306+
- Supported
310307
- Experimental
311308
- Experimental
312309
* - **Hardware cryptography acceleration**
313310
- Supported
314311
- Supported
315312
- Supported
316-
- Experimental
317-
- Experimental
313+
- Supported
318314
- n/a
315+
- Experimental
319316
* - **Multiple signature keys**
320317
- Supported
321318
- Supported
322319
- Supported
323-
- Experimental
324-
- Experimental
320+
- Supported
325321
- --
322+
- Experimental

‎doc/nrf-bm/release_notes/release_notes_2.0.0-preview1.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:orphan:
2+
13
.. _nrf_bm_release_notes_200-preview1:
24

35
Changelog for |BMlong| v2.0.0-preview1

0 commit comments

Comments
 (0)