doc: remove zigbee documentation #20843

annwoj · 2025-03-10T19:21:31Z

Docs are now located in a separate repository.
Removed the documentation.
Left protocol and samples placeholder as agreed.
Added the agreed deprecation note.
Left a note in release notes and known issues.

NordicBuilder · 2025-03-10T19:23:09Z

CI Information

^{To view the history of this post, clich the 'edited' button above}
Build number: 16

Inputs:

Sources:

sdk-nrf: PR head: 81bdd5d1a05793382d94264e58bbec36b6fafff0

more details

sdk-nrf:

PR head: 81bdd5d1a05793382d94264e58bbec36b6fafff0
merge base: e48012d792deccafb2db8614e3633be2ddd8ee59
target head (main): d5d91c8c5f34ec2d233a945776b088a86ae39c8a
Diff

Github labels

Enabled	Name	Description
	ci-disabled	Disable the ci execution
	ci-all-test	Run all of ci, no test spec filtering will be done
	ci-force-downstream	Force execution of downstream even if twister fails
	ci-run-twister	Force run twister
	ci-run-zephyr-twister	Force run zephyr twister

List of changed files detected by CI (106)

CODEOWNERS
applications
│  ├── zigbee_weather_station
│  │  │ README.rst
doc
│  ├── _utils
│  │  │ redirects.py
│  ├── _zoomin
│  │  │ ncs.tags.yml
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── config_and_build
│  │  │  │  │ config_and_build_system.rst
│  │  │  ├── device_guides
│  │  │  │  ├── nrf52
│  │  │  │  │  ├── features.rst
│  │  │  │  │  │ fota_update.rst
│  │  ├── applications.rst
│  │  ├── includes
│  │  │  │ zigbee_deprecation.txt
│  │  ├── libraries
│  │  │  ├── zigbee
│  │  │  │  ├── images
│  │  │  │  │  ├── zigbee_signal_handler_00_stack_init.png
│  │  │  │  │  ├── zigbee_signal_handler_00_stack_init.uml
│  │  │  │  │  ├── zigbee_signal_handler_01_production_config.png
│  │  │  │  │  ├── zigbee_signal_handler_01_production_config.svg
│  │  │  │  │  ├── zigbee_signal_handler_01_production_config.uml
│  │  │  │  │  ├── zigbee_signal_handler_02_startup.png
│  │  │  │  │  ├── zigbee_signal_handler_02_startup.svg
│  │  │  │  │  ├── zigbee_signal_handler_02_startup.uml
│  │  │  │  │  ├── zigbee_signal_handler_03_first_start.png
│  │  │  │  │  ├── zigbee_signal_handler_03_first_start.svg
│  │  │  │  │  ├── zigbee_signal_handler_03_first_start.uml
│  │  │  │  │  ├── zigbee_signal_handler_04_reboot.png
│  │  │  │  │  ├── zigbee_signal_handler_04_reboot.svg
│  │  │  │  │  ├── zigbee_signal_handler_04_reboot.uml
│  │  │  │  │  ├── zigbee_signal_handler_05_formation.png
│  │  │  │  │  ├── zigbee_signal_handler_05_formation.svg
│  │  │  │  │  ├── zigbee_signal_handler_05_formation.uml
│  │  │  │  │  ├── zigbee_signal_handler_06_steering.png
│  │  │  │  │  ├── zigbee_signal_handler_06_steering.svg
│  │  │  │  │  ├── zigbee_signal_handler_06_steering.uml
│  │  │  │  │  ├── zigbee_signal_handler_07_idle.png
│  │  │  │  │  ├── zigbee_signal_handler_07_idle.svg
│  │  │  │  │  ├── zigbee_signal_handler_07_idle.uml
│  │  │  │  │  ├── zigbee_signal_handler_08_deep_sleep.png
│  │  │  │  │  ├── zigbee_signal_handler_08_deep_sleep.svg
│  │  │  │  │  ├── zigbee_signal_handler_08_deep_sleep.uml
│  │  │  │  │  ├── zigbee_signal_handler_09_leave.png
│  │  │  │  │  ├── zigbee_signal_handler_09_leave.svg
│  │  │  │  │  ├── zigbee_signal_handler_09_leave.uml
│  │  │  │  │  ├── zigbee_signal_handler_10_rejoin.svg
│  │  │  │  │  ├── zigbee_signal_handler_10_rejoin_stop.svg
│  │  │  │  │  ├── zigbee_signal_handler_10_rejoin_user_input.svg
│  │  │  │  │  │ zigbee_signal_handler_overview.svg
│  │  │  │  ├── index.rst
│  │  │  │  ├── osif.rst
│  │  │  │  ├── shell.rst
│  │  │  │  ├── zigbee_app_utils.rst
│  │  │  │  ├── zigbee_error_handler.rst
│  │  │  │  ├── zigbee_fota.rst
│  │  │  │  ├── zigbee_logger_eprxzcl.rst
│  │  │  │  │ zigbee_zcl_scenes.rst
│  │  ├── links.txt
│  │  ├── protocols
│  │  │  ├── zigbee
│  │  │  │  ├── adding_clusters.rst
│  │  │  │  ├── architectures.rst
│  │  │  │  ├── commissioning.rst
│  │  │  │  ├── configuring.rst
│  │  │  │  ├── configuring_libraries.rst
│  │  │  │  ├── configuring_zboss_traces.rst
│  │  │  │  ├── images
│  │  │  │  │  ├── zigbee_commissioning_fb.svg
│  │  │  │  │  ├── zigbee_commissioning_formation.svg
│  │  │  │  │  ├── zigbee_commissioning_overview.svg
│  │  │  │  │  ├── zigbee_commissioning_steering.svg
│  │  │  │  │  ├── zigbee_platform_design_multi.svg
│  │  │  │  │  ├── zigbee_platform_design_nRF53.svg
│  │  │  │  │  ├── zigbee_platform_design_nRF5340_multi.svg
│  │  │  │  │  ├── zigbee_platform_design_ncp.svg
│  │  │  │  │  ├── zigbee_platform_design_soc.svg
│  │  │  │  │  ├── zigbee_qsg_topology.svg
│  │  │  │  │  ├── zigbee_qsg_vsc_flash.png
│  │  │  │  │  │ zigbee_topology_types.svg
│  │  │  │  ├── index.rst
│  │  │  │  ├── memory.rst
│  │  │  │  ├── other_ecosystems.rst
│  │  │  │  ├── qsg.rst
│  │  │  │  ├── supported_features.rst
│  │  │  │  │ tools.rst
│  │  ├── releases_and_maturity
│  │  │  ├── known_issues.rst
│  │  │  ├── releases
│  │  │  │  ├── release-notes-1.3.0.rst
│  │  │  │  ├── release-notes-1.4.0.rst
│  │  │  │  ├── release-notes-1.5.0.rst
│  │  │  │  ├── release-notes-1.5.1.rst
│  │  │  │  ├── release-notes-1.6.0.rst
│  │  │  │  ├── release-notes-1.6.1.rst
│  │  │  │  ├── release-notes-1.7.0.rst
│  │  │  │  ├── release-notes-1.8.0.rst
│  │  │  │  ├── release-notes-1.9.0.rst
│  │  │  │  ├── release-notes-2.0.0.rst
│  │  │  │  ├── release-notes-2.1.0.rst
│  │  │  │  ├── release-notes-2.4.0.rst
│  │  │  │  ├── release-notes-2.6.0.rst
│  │  │  │  ├── release-notes-2.7.0.rst
│  │  │  │  ├── release-notes-2.8.0-preview1.rst
│  │  │  │  ├── release-notes-2.8.0.rst
│  │  │  │  ├── release-notes-2.9.0-nRF54H20-1-rc3.rst
│  │  │  │  ├── release-notes-2.9.0.rst
│  │  │  │  │ release-notes-changelog.rst
│  │  ├── samples
│  │  │  │ zigbee.rst
│  │  ├── shortcuts.txt
│  │  ├── test_and_optimize
│  │  │  ├── debugging.rst
│  │  │  ├── logging.rst
│  │  │  ├── optimizing
│  │  │  │  │ memory.rst
samples
│  ├── zigbee
│  │  ├── light_bulb
│  │  │  │ README.rst
│  │  ├── light_switch
│  │  │  │ README.rst
│  │  ├── ncp
│  │  │  │ README.rst
│  │  ├── network_coordinator
│  │  │  │ README.rst
│  │  ├── shell
│  │  │  │ README.rst
│  │  ├── template
│  │  │  │ README.rst

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

◻️ Toolchain
◻️ Build twister
◻️ Integration tests
- ◻️ test-fw-nrfconnect-zigbee

Disabled integration tests

- desktop52_verification
- doc-internal
- test_ble_nrf_config
- test-fw-nrfconnect-apps
- test-fw-nrfconnect-ble_mesh
- test-fw-nrfconnect-ble_samples
- test-fw-nrfconnect-boot
- test-fw-nrfconnect-chip
- test-fw-nrfconnect-fem
- test-fw-nrfconnect-nfc
- test-fw-nrfconnect-nrf-iot_cloud
- test-fw-nrfconnect-nrf-iot_libmodem-nrf
- test-fw-nrfconnect-nrf-iot_mosh
- test-fw-nrfconnect-nrf-iot_positioning
- test-fw-nrfconnect-nrf-iot_samples
- test-fw-nrfconnect-nrf-iot_serial_lte_modem
- test-fw-nrfconnect-nrf-iot_thingy91
- test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
- test-fw-nrfconnect-nrf_crypto
- test-fw-nrfconnect-proprietary_esb
- test-fw-nrfconnect-ps
- test-fw-nrfconnect-rpc
- test-fw-nrfconnect-rs
- test-fw-nrfconnect-tfm
- test-fw-nrfconnect-thread
- test-low-level
- test-sdk-audio
- test-sdk-dfu
- test-sdk-find-my
- test-sdk-mcuboot
- test-sdk-pmic-samples
- test-sdk-sidewalk
- test-sdk-wifi
- test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

annwoj · 2025-03-14T19:34:01Z

doc/nrf/protocols/zigbee/index.rst

+.. _zigbee_ncp_sample:
+.. _zigbee_ug_configuration:
+.. _ug_zigbee_platform_design_ncp_details:


keeping these here temporarily as they cause build errors on the nrfxlib side

github-actions · 2025-03-14T19:34:07Z

You can find the documentation preview for this PR here.

Preview links for modified nRF Connect SDK documents:

doc/nrf/protocols/zigbee/index.rst

doc/nrf/samples/zigbee.rst

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

doc/nrf/app_dev/config_and_build/config_and_build_system.rst

milewr · 2025-03-17T09:55:13Z

@annwoj should be any information not only in change log but also in release notes and Zigbee section that it is available ad R22 add-on?

annwoj · 2025-03-17T10:47:50Z

@annwoj should be any information not only in change log but also in release notes and Zigbee section that it is available ad R22 add-on?

Changelog is a file that temporarily holds the release note items. They are kept there until a release notes PR is opened before the given release.

doc/nrf/app_dev/config_and_build/config_and_build_system.rst

doc/nrf/app_dev/device_guides/nrf52/features.rst

doc/nrf/protocols/zigbee/index.rst

doc/_utils/redirects.py

divipillai · 2025-03-17T13:24:19Z

doc/nrf/links.txt

@@ -197,6 +197,8 @@

 .. _`commit #d55314`: https://github.com/nrfconnect/sdk-nrf/commit/d553142f4f37bc324da9869e4837cdd9105e25ab

+.. _`Zigbee R22`: https://github.com/nrfconnect/ncs-zigbee-r22
+.. _`Zigbee R23`: https://github.com/nrfconnect/ncs-zigbee


¨There could be external Zigbee links that are now no longer required with this removal. Maybe we could remove those links from the link.txt file.

Yes, there are, but I was planning to do that in a separate PR as a part of clean-up activities. This PR should go in as soon as possible

umapraseeda · 2025-03-17T14:53:13Z

Following entries need to be removed:

annwoj · 2025-03-18T06:41:45Z

Following entries need to be removed:

https://github.com/nrfconnect/sdk-nrf/blob/main/CODEOWNERS#L53,

https://github.com/nrfconnect/sdk-nrf/blob/main/CODEOWNERS#L232

https://github.com/nrfconnect/sdk-nrf/blob/main/doc/_zoomin/ncs.tags.yml#L314,

https://github.com/nrfconnect/sdk-nrf/blob/main/doc/_zoomin/ncs.tags.yml#L396

https://github.com/nrfconnect/sdk-nrf/blob/main/doc/_zoomin/ncs.tags.yml#L289 until https://github.com/nrfconnect/sdk-nrf/blob/main/doc/_zoomin/ncs.tags.yml#L292

Hi Uma, for the codeowners file the lines you mentioned were already removed before, unless I'm missing something (?). Please let me know in case this requires additional changes.
Applied the suggestion for tags file:)

doc/_zoomin/ncs.tags.yml

Docs are now located in a separate repository. Signed-off-by: Anna Wojdylo <[email protected]>

sonarqubecloud · 2025-03-18T08:11:33Z

Quality Gate failed

Failed conditions
B Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

annwoj · 2025-03-18T11:03:27Z

@carlescufi or @gmarull could you please take a look?

annwoj added the doc-required PR must not be merged without tech writer approval. label Mar 10, 2025

github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Mar 10, 2025

annwoj force-pushed the remove_zigbee_docs branch from 7711d4e to 2041a49 Compare March 11, 2025 13:36

github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Mar 11, 2025

annwoj force-pushed the remove_zigbee_docs branch 8 times, most recently from 07ddeb8 to 4f2ca12 Compare March 14, 2025 19:14

annwoj commented Mar 14, 2025

View reviewed changes

annwoj force-pushed the remove_zigbee_docs branch 2 times, most recently from 7f8411e to c73eacb Compare March 14, 2025 19:39

annwoj marked this pull request as ready for review March 14, 2025 19:43

annwoj requested review from a team as code owners March 14, 2025 19:43

milewr reviewed Mar 17, 2025

View reviewed changes

annwoj changed the title ~~doc: WIP remove zigbee documentation~~ doc: remove zigbee documentation Mar 17, 2025

annwoj force-pushed the remove_zigbee_docs branch from c73eacb to a6f5fe2 Compare March 17, 2025 11:09

annwoj requested a review from milewr March 17, 2025 11:10

divipillai reviewed Mar 17, 2025

View reviewed changes

doc/nrf/app_dev/config_and_build/config_and_build_system.rst Outdated Show resolved Hide resolved

doc/nrf/app_dev/device_guides/nrf52/features.rst Outdated Show resolved Hide resolved

doc/nrf/protocols/zigbee/index.rst Show resolved Hide resolved

annwoj force-pushed the remove_zigbee_docs branch from a6f5fe2 to 46660d7 Compare March 17, 2025 12:57

annwoj requested a review from divipillai March 17, 2025 12:57

milewr approved these changes Mar 17, 2025

View reviewed changes

divipillai reviewed Mar 17, 2025

View reviewed changes

nordicjm approved these changes Mar 17, 2025

View reviewed changes

annwoj force-pushed the remove_zigbee_docs branch from 46660d7 to e9709a3 Compare March 18, 2025 06:42

annwoj requested a review from a team as a code owner March 18, 2025 06:42

annwoj requested a review from divipillai March 18, 2025 06:44

divipillai approved these changes Mar 18, 2025

View reviewed changes

doc/_zoomin/ncs.tags.yml Show resolved Hide resolved

doc: Remove zigbee documentation

81bdd5d

Docs are now located in a separate repository. Signed-off-by: Anna Wojdylo <[email protected]>

annwoj force-pushed the remove_zigbee_docs branch from e9709a3 to 81bdd5d Compare March 18, 2025 08:05

b-gent approved these changes Mar 18, 2025

View reviewed changes

gmarull approved these changes Mar 18, 2025

View reviewed changes

nordicjm merged commit 0011ff5 into nrfconnect:main Mar 18, 2025
13 of 14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: remove zigbee documentation #20843

doc: remove zigbee documentation #20843

annwoj commented Mar 10, 2025 •

edited

Loading

NordicBuilder commented Mar 10, 2025 •

edited

Loading

annwoj Mar 14, 2025

github-actions bot commented Mar 14, 2025 •

edited

Loading

milewr commented Mar 17, 2025

annwoj commented Mar 17, 2025

divipillai Mar 17, 2025

annwoj Mar 17, 2025

umapraseeda commented Mar 17, 2025

annwoj commented Mar 18, 2025

sonarqubecloud bot commented Mar 18, 2025

annwoj commented Mar 18, 2025

doc: remove zigbee documentation #20843

doc: remove zigbee documentation #20843

Conversation

annwoj commented Mar 10, 2025 • edited Loading

NordicBuilder commented Mar 10, 2025 • edited Loading

CI Information

Inputs:

Sources:

Github labels

Outputs:

Toolchain

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

annwoj Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot commented Mar 14, 2025 • edited Loading

milewr commented Mar 17, 2025

annwoj commented Mar 17, 2025

divipillai Mar 17, 2025

Choose a reason for hiding this comment

annwoj Mar 17, 2025

Choose a reason for hiding this comment

umapraseeda commented Mar 17, 2025

annwoj commented Mar 18, 2025

sonarqubecloud bot commented Mar 18, 2025

Quality Gate failed

annwoj commented Mar 18, 2025

annwoj commented Mar 10, 2025 •

edited

Loading

NordicBuilder commented Mar 10, 2025 •

edited

Loading

github-actions bot commented Mar 14, 2025 •

edited

Loading