Skip to content

Commit 458b9a1

Browse files
greg-ferrlubos
authored andcommitted
doc: add-ons: add information about the index
Added mentions of the nRF Connect SDK Add-ons page and the ncs-app-index repository to the pages Create an application and Integrations. Added a glossary entry. VSC-2765. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent 75f9dd8 commit 458b9a1

File tree

5 files changed

+45
-0
lines changed

5 files changed

+45
-0
lines changed

doc/nrf/app_dev/create_application.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ This application type is suitable for the following development cases:
100100
* You want to make changes to one or more of the repositories of the |NCS| when working on the application.
101101
* You want to develop a project that involves more than one board target, for example using a mesh networking protocol like :ref:`ug_matter` or :ref:`ug_bt_mesh`.
102102
* You want to run a big project that lets you develop most features without having to patch the |NCS| tree, for example with out-of-tree boards, drivers, SoCs, and so on.
103+
* You want to use out-of-tree applications from the `nRF Connect SDK Add-ons`_ index.
103104

104105
For more information about applications placed in workspace in the |NCS|, see the :ref:`workflow 4 on the development model page <dm_workflow_4>`.
105106

@@ -291,3 +292,34 @@ Use the following steps depending on the application type:
291292
This allows CMake to automatically load the boilerplate code required for building |NCS| applications.
292293

293294
You can now start :ref:`configuring and building <configuration_and_build>` the application using the command line.
295+
296+
.. _creating_add_on_index:
297+
298+
Creating application from add-ons
299+
=================================
300+
301+
You can create a :ref:`workspace application <create_application_types_workspace>` also by browsing and copying reference applications from the `nRF Connect SDK Add-ons`_ index.
302+
The index is a collection of publicly available |NCS| supplementary components that extend the SDK's functionality.
303+
In addition to applications, it includes drivers, libraries, and protocol implementations.
304+
305+
To create an application from the add-on index, complete the following steps:
306+
307+
.. tabs::
308+
309+
.. tab:: nRF Connect for VS Code (recommended)
310+
311+
Complete the following steps in the |nRFVSC|:
312+
313+
1. In the :guilabel:`Welcome View`, click :guilabel:`Create a new application`.
314+
#. Select :guilabel:`Browse nRF Connect SDK Add-on Index`.
315+
#. Browse through the available add-ons and select one that matches your needs.
316+
#. Follow the creation wizard to set up your workspace application.
317+
318+
.. tab:: Command line
319+
320+
When creating add-on applications from the command line, follow the instructions provided in the `nRF Connect SDK Add-ons`_ repository.
321+
These instructions guide you through the process of copying and configuring the add-on application in your workspace.
322+
323+
The add-on is copied to your workspace and automatically configured with a west workspace, allowing you to start development right away.
324+
325+
For more information, including how to contribute your own add-on to the index, read :file:`README.md` and :file:`CONTRIBUTING.md` in the `ncs-app-index repository <ncs-app-index_>`_.

doc/nrf/glossary.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -603,6 +603,13 @@ Glossary
603603
It includes a public REST API that can be used for building IoT solutions.
604604
See `nRF Cloud`_.
605605

606+
nRF Connect SDK Add-ons
607+
An index of publicly available supplementary components that extend the |NCS|'s functionality.
608+
The index can be accessed from the |nRFVSC|, and can also be browsed on `add-on webpage <nRF Connect SDK Add-ons_>`_.
609+
Add-ons in the index follow specific contribution guidelines and are maintained by their respective owners.
610+
The workspace applications listed there can be used to create out-of-tree :ref:`workspace applications <creating_add_on_index>`.
611+
For more information, including how to contribute your own add-on to the index, read :file:`README.md` and :file:`CONTRIBUTING.md` in the `ncs-app-index repository <ncs-app-index_>`_.
612+
606613
nRF repository
607614
An |NCS| repository, hosted in the `nrfconnect GitHub organization`_, that does not have an externally maintained, open-source upstream.
608615
It is exclusive to Nordic development.

doc/nrf/integrations.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ Integrations of the following third-party products are documented in their priva
1111

1212
In the case of Find My, MFi licensees can get access to the repository by issuing a Nordic `DevZone`_ private ticket.
1313

14+
.. note::
15+
Integrations are available also through the `nRF Connect SDK Add-ons`_, a curated collection of supplementary |NCS| components.
16+
For more information, including how to contribute your own add-on to the index, read :file:`README.md` and :file:`CONTRIBUTING.md` in the `ncs-app-index repository <ncs-app-index_>`_.
17+
1418
The following user guides describe available integrations:
1519

1620
.. toctree::

doc/nrf/links.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,7 @@
226226
.. _`Memfault WebBluetooth Client`: https://memfault.github.io/web-ble-example/
227227

228228
.. _`nRF Connect SDK Add-ons`: https://nrfconnect.github.io/ncs-app-index/
229+
.. _`ncs-app-index`: https://github.com/nrfconnect/ncs-app-index
229230

230231
.. ### Source: githubusercontent.com
231232

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -679,5 +679,6 @@ Documentation
679679
* New page :ref:`thingy53_precompiled` under :ref:`ug_thingy53`.
680680
This page includes some of the information previously located on the standalone page for getting started with Nordic Thingy:53.
681681

682+
* Updated the :ref:`create_application` page with the :ref:`creating_add_on_index` section.
682683
* Removed the standalone page for getting started with Nordic Thingy:53.
683684
The contents of this page have been moved to the :ref:`thingy53_precompiled` page and to the `Programmer app <Programming Nordic Thingy:53_>`_ documentation.

0 commit comments

Comments
 (0)