Skip to content

Commit cdbbbba

Browse files
docs: Added release note for v.0.1.0
Added release notes for v0.1.0 and introduced few small improvements in other docs sections. Signed-off-by: Kamil Kasperczyk <kamil.kasperczyk@nordicsemi.no>
1 parent 6679c88 commit cdbbbba

8 files changed

Lines changed: 48 additions & 12 deletions

File tree

docs/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,17 @@ In combination with the |NCS|, the |addon| allows for development of KNX IoT app
99
If you are new to KNX or KNX IoT, start with the :ref:`knx_iot_overview` for an introduction to the protocol and its infrastructure.
1010
For architecture and integration details, see :ref:`knx_iot_addon`.
1111

12+
.. note::
13+
The |addon| is provided as an `experimental feature <Software maturity levels_>`_.
14+
1215
.. toctree::
1316
:maxdepth: 2
1417
:caption: Contents
1518

1619
knx-iot/overview/index
1720
knx-iot/addon
18-
knx-iot/setup
1921
knx-iot/samples
22+
setup
2023
config
2124
software_maturity
2225
known_issues

docs/known_issues.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ A known issue can list one or both of the following entries:
3131

3232
wontfix Won't fix
3333

34-
List of known issues
35-
********************
34+
List of known issues for v0.1.0 release
35+
***************************************
3636

37-
There are no known issues for the |addon| at this time.
37+
The following release is `experimental <Software maturity levels_>`_.
38+
Because of this, not all behavior is fully defined or validated.

docs/links.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
.. _`Installing the nRF Connect SDK`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/installation/install_ncs.html
44
.. _`Developing with nRF54L Series`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/app_dev/device_guides/nrf54l/index.html
5+
.. _`Software maturity levels`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/releases_and_maturity/software_maturity.html
56

67
.. ### NCS documentation set
78

docs/release-notes.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@
33
Release notes
44
#############
55

6-
.. contents::
7-
:local:
8-
:depth: 2
6+
For detailed list on new features for a specific |addon| release, refer to the following:
97

10-
All the notable changes to the |addon| for the |NCS| are listed here.
8+
.. toctree::
9+
:maxdepth: 1
10+
:caption: Contents
11+
:glob:
12+
13+
release_notes/release_notes_v010.rst
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _release_notes_vTBA:
2+
3+
Release notes for |addon| v0.1.0
4+
################################
5+
6+
.. contents::
7+
:local:
8+
:depth: 2
9+
10+
This page tracks changes and updates as compared to the latest official release.
11+
For more information refer to the following section.
12+
13+
For the list of potential issues, see the :ref:`knx_iot_known_issues` page.
14+
15+
Changelog
16+
*********
17+
18+
This is the first `experimental <Software maturity levels_>`_ release of the |addon|.
19+
20+
Added:
21+
22+
* The :ref:`knx_iot_light_switch_actuator_sample` sample.
23+
* The :ref:`knx_iot_light_switch_sensor_sample` sample.
24+
* The integration of the KNX IoT Point API stack (version 1.0.0).
25+
* The support for the nRF54L15 and nRF54LM20A/B SoCs.
26+
* The support for KNX commissioning using hardcoded credentials.
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ This page outlines the requirements that you need to meet before you start worki
88
Hardware requirements
99
*********************
1010

11-
The |addon| supports the nRF54L15 and nRF54LM20A/B SoCs.
11+
To use the |addon|, you need one of the following development kits:
12+
13+
.. table-from-sample-yaml::
1214

1315
Software requirements
1416
*********************

docs/shortcuts.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
.. |ncs_version| replace:: 3.4.0
44
.. |knx-iot_version| replace:: 1.0.0
5-
.. |addon_version| replace:: 1.0.0
5+
.. |addon_version| replace:: 0.1.0
66

77
.. |NCS| replace:: nRF Connect SDK
88
.. |addon| replace:: KNX-IoT add-on

docs/versions.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
[
2-
"1.0.99",
3-
"1.0.0"
2+
"0.1.99",
3+
"0.1.0"
44
]

0 commit comments

Comments
 (0)