Skip to content

Commit 31c833e

Browse files
b-gentkkasperczyk-no
b-gent
authored and
kkasperczyk-no
committed
doc: review for knx iot add-on v0.1.0
Review across doc files - small structure, content, and build fixes. Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no>
1 parent 24bad08 commit 31c833e

14 files changed

Lines changed: 48 additions & 37 deletions

File tree

‎.github/workflows/doc_build.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
- name: Install system dependencies
5252
run: |
5353
sudo apt update
54-
sudo apt-get install -y graphviz plantuml
54+
sudo apt-get install -y graphviz plantuml mscgen
5555
wget --no-verbose "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz"
5656
sudo tar xf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz -C /opt
5757
echo "/opt/doxygen-${DOXYGEN_VERSION}/bin" >> $GITHUB_PATH

‎docs/conf.py‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@
1010
# -- Project information -----------------------------------------------------
1111
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
1212

13-
project = 'KNX IoT add-on for nRF Connect SDK'
13+
project = 'KNX IoT Add-on for the nRF Connect SDK'
1414
copyright = '2026, Nordic Semiconductor'
1515
author = 'Nordic Semiconductor'
16-
release = '1.0.0'
16+
release = '0.1.0'
17+
version = '0.1.0'
1718

1819
# Paths
1920

@@ -50,8 +51,15 @@
5051

5152
html_theme_options = {
5253
'docsets': {},
54+
"ncs_url": "https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/",
55+
"ncs_label": "nRF Connect SDK Docs",
56+
"addons_url": "https://nrfconnect.github.io/ncs-app-index/",
57+
"bare_metal_url": "",
58+
"logo_url": "https://docs.nordicsemi.com",
5359
}
5460

61+
html_show_sphinx = False
62+
5563
# Copied into the HTML output for the hosted documentation version switcher.
5664
html_extra_path = ['versions.json']
5765

‎docs/config.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Shared configurations in |addon|
44
################################
55

6+
The |addon| provides a set of Kconfig options that are shared across all of its samples.
7+
8+
Use these options to enable the KNX IoT stack, control commissioning behavior, and tune the runtime and logging of the shared KNX integration library.
9+
610
Configuration options
711
*********************
812

‎docs/includes/sample_board_rows.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
.. nrf54l15dk_nrf54l15_cpuapp
66

7-
| `Developing with nRF54L Series`_ | PCA10156 | `nrf54l15dk`_ | ``nrf54l15dk/nrf54l15/cpuapp`` |
7+
| `nRF54L15 DK <Developing with nRF54L Series_>`_ | PCA10156 | `nrf54l15dk`_ | ``nrf54l15dk/nrf54l15/cpuapp`` |
88

99
.. nrf54lm20dk_nrf54lm20a_cpuapp
1010

11-
| `Developing with nRF54L Series`_ | PCA10184 | `nrf54lm20dk`_ | ``nrf54lm20dk/nrf54lm20a/cpuapp`` |
11+
| `nRF54LM20A DK <Developing with nRF54L Series_>`_ | PCA10184 | `nrf54lm20dk`_ | ``nrf54lm20dk/nrf54lm20a/cpuapp`` |
1212

1313
.. nrf54lm20dk_nrf54lm20b_cpuapp
1414

15-
| `Developing with nRF54L Series`_ | PCA10184 | `nrf54lm20dk`_ | ``nrf54lm20dk/nrf54lm20b/cpuapp`` |
15+
| `nRF54LM20B DK <Developing with nRF54L Series_>`_ | PCA10184 | `nrf54lm20dk`_ | ``nrf54lm20dk/nrf54lm20b/cpuapp`` |

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ For architecture and integration details, see :ref:`knx_iot_addon`.
1818

1919
knx-iot/overview/index
2020
knx-iot/addon
21-
knx-iot/samples
2221
setup
22+
knx-iot/samples
2323
config
2424
software_maturity
2525
known_issues

‎docs/known_issues.rst‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ A known issue can list one or both of the following entries:
2222
Sometimes, they are discovered later and added over time.
2323

2424
.. version-filter::
25-
:default: v1-0-0
25+
:default: v0-1-0
2626
:container: dl/dt
2727
:tags: [("wontfix", "Won't fix")]
2828

@@ -31,15 +31,17 @@ A known issue can list one or both of the following entries:
3131

3232
wontfix Won't fix
3333

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

3737
The following release is `experimental <Software maturity levels_>`_.
3838
Because of this, not all behavior is fully defined or validated.
3939

4040
.. _knx_iot_known_issue_actuator_state_not_persisted:
4141

42-
KRKNWK-22216: The actuator light state is not persisted after reboot
42+
.. rst-class:: v0-1-0
43+
44+
KRKNWK-22216: The actuator light state does not persist after reboot
4345
The light switch actuator sample does not store the switched load state in non-volatile memory.
4446
After a reboot, **LED 2** is always off, even if the light was on before the reset.
4547

‎docs/knx-iot/addon.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
This page describes what the |addon| provides and how it integrates the KNX IoT Point API stack into the |NCS|.
1111
For the protocol concepts referenced here, see the :ref:`knx_iot_overview`.
1212

13-
What the |addon| provides
14-
*************************
13+
Add-on components
14+
*****************
1515

1616
The |addon| brings the KNX IoT Point API to Nordic Semiconductor devices running the |NCS|.
1717
It consists of the following parts:

‎docs/knx-iot/overview/architecture.rst‎

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

3-
KNX IoT architecture
4-
####################
3+
KNX IoT protocol stack architecture
4+
###################################
55

66
.. contents::
77
:local:

‎docs/links.txt‎

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

77
.. ### NCS documentation set
88

9-
.. _`configure_application`: https://nrfconnectdocs.nordicsemi.com/ncs-|ncs_version|/nrf/app_dev/config_and_build/index.html
9+
.. _`Configuring and building`: https://nrfconnectdocs.nordicsemi.com/ncs/|ncs_version|/nrf/app_dev/config_and_build/index.html
1010

1111
.. ### Zephyr documentation set
1212

‎docs/release-notes.rst‎

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

6-
For detailed list on new features for a specific |addon| release, refer to the following:
6+
For a detailed list on new features for a specific |addon| release, refer to the respective release notes documents.
77

8+
The |addon| v\ |addon_version| is compatible with |NCS| v\ |ncs_version| and uses `KNX IoT Point API Stack`_ v\ |knx-iot_version|.
89

9-
All the notable changes to the |addon| for the |NCS| are listed here.
10-
11-
The |addon| v\ |addon_version| is compatible with |NCS| v\ |ncs_version| and
12-
uses `KNX IoT Point API Stack`_ v\ |knx-iot_version|.
13-
For a full list of |addon| releases and related |NCS| and
14-
`KNX IoT Point API Stack`_ versions, view the following table:
10+
The following table contains a full list of |addon| releases and related |NCS| and `KNX IoT Point API Stack`_ versions.
1511

1612
.. list-table::
1713
:header-rows: 1

0 commit comments

Comments
 (0)