Skip to content

doc: clarify expected usage for tools and libraries - #147

Open
edmont wants to merge 1 commit into
nrfconnect:mainfrom
edmont:pr/docs-clarification
Open

edmont wants to merge 1 commit into
nrfconnect:mainfrom
edmont:pr/docs-clarification

Conversation

@edmont

@edmont edmont commented Sep 16, 2026

Copy link
Copy Markdown
Collaborator

Improve the documentation to make clear that some of the components are intended for testing purposes, not for production.

Improve the documentation to make clear that some of the components
are intended for testing purposes, not for production.

Signed-off-by: Eduardo Montoya <eduardo.montoya@nordicsemi.no>
@edmont
edmont requested a review from a team as a code owner September 16, 2026 13:37
@github-actions

Copy link
Copy Markdown
Contributor

@edmont
edmont requested a review from annwoj September 17, 2026 06:10

@kkasperczyk-no kkasperczyk-no left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

Comment thread docs/tools.rst
:start-after: zigbee_logger_endpoint_intro_start
:end-before: zigbee_logger_endpoint_intro_end

|zigbee_logger_dev_only|

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already included in lib/zigbee_logger_eprxzcl.rst
Due to that the note is printed twice

Comment thread samples/ncp/README.rst
You can then use this sample together with the :ref:`Zigbee Light bulb <zigbee_light_bulb_sample>` to set up a basic Zigbee network.

.. important::
|zigbee_samples_dev_only|

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already mentioned in docs/samples/index.rst for all samples. Why mentioned again for NCP and Shell but not for other samples?

Comment thread samples/shell/README.rst
This Shell sample demonstrates a Zigbee router (with the possibility of being a coordinator) that uses the :ref:`lib_zigbee_shell` library for interaction.

.. important::
|zigbee_samples_dev_only|

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already mentioned in docs/samples/index.rst for all samples. Why mentioned again for NCP and Shell but not for other samples?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants