Skip to content

Commit

Permalink
doc: move getting started to evaluation guides
Browse files Browse the repository at this point in the history
Moved device getting started guides to evaluation guides above
installation. NCSDK-22328.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
Co-authored-by: Divya Pillai <Divya.Pillai@nordicsemi.no>
  • Loading branch information
greg-fer and divipillai committed Apr 26, 2024
1 parent a5b430e commit 3a2bfab
Show file tree
Hide file tree
Showing 49 changed files with 79 additions and 61 deletions.
2 changes: 1 addition & 1 deletion doc/nrf/device_guides/nrf52.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.. _ug_nrf52_group:
.. _nrf52_supported_boards:
.. _nrf52_working:

Working with nRF52 Series
#########################
Expand Down Expand Up @@ -64,5 +65,4 @@ See also :ref:`ug_radio_fem_nrf21540ek` to learn how to use the RF front-end mod
:caption: Subpages:

working_with_nrf/nrf52/features
working_with_nrf/nrf52/gs
working_with_nrf/nrf52/developing
3 changes: 1 addition & 2 deletions doc/nrf/device_guides/nrf53.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _ug_nrf53:
.. _nrf53_working:

Working with nRF53 Series
#########################
Expand Down Expand Up @@ -32,8 +33,6 @@ Zephyr and the |NCS| provide support and contain board definitions for developin
:caption: Subpages:

working_with_nrf/nrf53/features_nrf53
working_with_nrf/nrf53/nrf5340_gs
working_with_nrf/nrf53/nrf5340
working_with_nrf/nrf53/qspi_xip_guide
working_with_nrf/nrf53/thingy53_gs
working_with_nrf/nrf53/thingy53
3 changes: 0 additions & 3 deletions doc/nrf/device_guides/nrf70.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,4 @@ Applications can be developed on the nRF7002 DK (PCA10143), which includes the n
:caption: Subpages:

working_with_nrf/nrf70/features
working_with_nrf/nrf70/gs
working_with_nrf/nrf70/nrf7002ek_gs
working_with_nrf/nrf70/nrf7002eb_gs
working_with_nrf/nrf70/developing/index
5 changes: 0 additions & 5 deletions doc/nrf/device_guides/nrf91.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ Zephyr and the |NCS| provide support for developing cellular applications using
The nRF Connect SDK also offers :ref:`samples <cellular_samples>` dedicated to these devices.

To get started with an nRF9161 DK, complete the steps in the Quick Start app in `nRF Connect for Desktop`_.
For more advanced topics related to the nRF9161 DK, see the :ref:`ug_nrf9161` documentation.

If you want to go through a hands-on online training to familiarize yourself with cellular IoT technologies and development of cellular applications, enroll in the `Cellular IoT Fundamentals course`_ in the `Nordic Developer Academy`_.

.. toctree::
Expand All @@ -49,8 +46,6 @@ If you want to go through a hands-on online training to familiarize yourself wit

working_with_nrf/nrf91/nrf91_features
working_with_nrf/nrf91/nrf9161
working_with_nrf/nrf91/nrf9160_gs
working_with_nrf/nrf91/nrf9160
working_with_nrf/nrf91/thingy91_gsg
working_with_nrf/nrf91/thingy91
working_with_nrf/nrf91/nrf91_snippet
10 changes: 5 additions & 5 deletions doc/nrf/device_guides/working_with_nrf/nrf52/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ See the :ref:`ug_bt_mesh` user guide for information about how to use the suppli
Enhanced ShockBurst
===================

.. include:: ../../../protocols/esb/index.rst
.. include:: /protocols/esb/index.rst
:start-after: esb_intro_start
:end-before: esb_intro_end

Expand All @@ -81,7 +81,7 @@ To start developing, check out the :ref:`esb_ptx` and :ref:`esb_prx` samples.
Gazell
======

.. include:: ../../../protocols/gazell/index.rst
.. include:: /protocols/gazell/index.rst
:start-after: gz_intro_start
:end-before: gz_intro_end

Expand All @@ -91,7 +91,7 @@ To start developing, check out the :ref:`gazell_samples`.
Matter
======

.. include:: ../../../protocols/matter/index.rst
.. include:: /protocols/matter/index.rst
:start-after: matter_intro_start
:end-before: matter_intro_end

Expand Down Expand Up @@ -126,7 +126,7 @@ The nrfx repository is included in the |NCS| as a module of the Zephyr repositor
Thread
======

.. include:: ../../../protocols/thread/index.rst
.. include:: /protocols/thread/index.rst
:start-after: thread_intro_start
:end-before: thread_intro_end

Expand All @@ -136,7 +136,7 @@ To start developing, refer to the :ref:`openthread_samples`.
Zigbee
======

.. include:: ../../../protocols/zigbee/index.rst
.. include:: /protocols/zigbee/index.rst
:start-after: zigbee_ug_intro_start
:end-before: zigbee_ug_intro_end

Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/device_guides/working_with_nrf/nrf70/nrf7002eb_gs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _ug_nrf7002eb_gs:

Getting started with nRF7002 EB
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/device_guides/working_with_nrf/nrf70/nrf7002ek_gs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _ug_nrf7002ek_gs:

Getting started with nRF7002 EK
Expand Down
6 changes: 3 additions & 3 deletions doc/nrf/device_guides/working_with_nrf/nrf91/nrf9160.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,14 @@ Make sure you are logged in to the `nRF Cloud`_ portal.

1. Click :guilabel:`Devices` under :guilabel:`Device Management` in the navigation pane on the left.

.. figure:: images/nrfcloud_devices.png
.. figure:: /gsg_guides/images/nrfcloud_devices.png
:alt: nRF Cloud - Devices

nRF Cloud - Devices

#. Click :guilabel:`Add Devices`.

.. figure:: images/nrfcloud_add_devices.png
.. figure:: /gsg_guides/images/nrfcloud_add_devices.png
:alt: nRF Cloud - Add Devices

nRF Cloud - Add Devices
Expand All @@ -74,7 +74,7 @@ Make sure you are logged in to the `nRF Cloud`_ portal.

#. Click :guilabel:`LTE Device` in the **Select Device Type** pop-up.

.. figure:: images/nrfcloud_selectdevicetype.png
.. figure:: /gsg_guides/images/nrfcloud_selectdevicetype.png
:alt: nRF Cloud - Select Device Type

nRF Cloud - Select Device Type
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/device_guides/working_with_nrf/nrf91/thingy91.rst
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ Updating the firmware in the nRF52840 SoC

In the Programmer navigation bar, :guilabel:`No devices available` changes to :guilabel:`SELECT DEVICE`.

.. figure:: ../nrf52/images/programmer_select_device1.png
.. figure:: images/programmer_select_device1.png
:alt: Programmer - Select device

Programmer - SELECT DEVICE
Expand Down
30 changes: 30 additions & 0 deletions doc/nrf/gsg_guides.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _gsg_guides:

Getting started guides
######################

Use the guides in this section to familiarize yourself with the |NCS| tools and components for some of the devices supported by the SDK.

.. important::
For the full list of devices supported in the |NCS|, see the :ref:`board support pages <programming_board_names>`.

These guides do not require installing the |NCS|.
They provide a guided experience using Nordic Semiconductor tools and precompiled binaries.

This is not a comprehensive section that includes all of the available getting started guides for Nordic Semiconductor devices.

.. note::
* To get started with the nRF9161 DK, complete the steps in the Quick Start app, available from `nRF Connect for Desktop`_.
* To get started with the nRF54L15 PDK, the installation of the |NCS| is required.
See :ref:`ug_nrf54l15_gs`.

.. toctree::
:maxdepth: 1
:caption: Subpages:

gsg_guides/nrf9160_gs
gsg_guides/thingy91_gsg
gsg_guides/nrf7002_gs
gsg_guides/nrf5340_gs
gsg_guides/thingy53_gs
gsg_guides/nrf52_gs
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,9 @@ Getting started with nRF52 Series
:local:
:depth: 2

This section gets you started with your nRF52 Series :term:`Development Kit (DK)` using the |NCS|.
This guide lets you evaluate the |NCS|'s support for nRF52 Series :term:`Development Kit (DK)` without the need of installing the SDK.
It tells you how to install the :ref:`peripheral_uart` sample and perform a quick test of your DK.

If you have already set up your nRF52 Series DK and want to learn more, see the following documentation:

* :ref:`installation` and :ref:`configuration_and_build` documentation to install the |NCS| and learn more about its development environment.
* :ref:`ug_nrf52` documentation for more advanced topics related to the nRF52 Series.

If you want to go through an online training course to familiarize yourself with Bluetooth Low Energy and the development of Bluetooth LE applications, enroll in the `Bluetooth LE Fundamentals course`_ in the `Nordic Developer Academy`_.

.. _nrf52_gs_requirements:
Expand Down Expand Up @@ -94,7 +89,7 @@ To program the precompiled sample to your development kit, complete the followin

#. Click **SELECT DEVICE** and select the DK from the drop-down list.

.. figure:: ../nrf52/images/programmer_select_device1.png
.. figure:: images/programmer_select_device1.png
:alt: Programmer - Select Device

Programmer - Select Device
Expand Down Expand Up @@ -166,7 +161,7 @@ To perform tests, complete the following steps:

This example communicates over Bluetooth Low Energy using the Nordic UART Service (NUS).

.. figure:: ../nrf52/images/nrf52_enable_cccds.png
.. figure:: images/nrf52_enable_cccds.png
:alt: nRF Connect for Mobile - Enable services option

nRF Connect for Mobile - Enable services option
Expand All @@ -177,7 +172,7 @@ To perform tests, complete the following steps:
The text is sent through the |DK| to your mobile device over a Bluetooth LE link.
The device displays the text in the nRF Connect for Mobile log:

.. figure:: ../nrf52/images/nrf52_connect_log.png
.. figure:: images/nrf52_connect_log.png
:alt: nRF Connect for Mobile - Text shown in the log

nRF Connect for Mobile - Text shown in the log
Expand All @@ -194,7 +189,7 @@ To perform tests, complete the following steps:

#. In the new window, select the **Client** tab and scroll to the bottom so you can see the **Client Characteristic Configuration** entry.

.. figure:: ../nrf52/images/nrf52_connect_client_ios.png
.. figure:: images/nrf52_connect_client_ios.png
:alt: nRF Connect for Mobile - Client tab

nRF Connect for Mobile - Client tab
Expand All @@ -207,7 +202,7 @@ To perform tests, complete the following steps:

This enables messages sent to the DK to show up in nRF Connect for Mobile.

.. figure:: ../nrf52/images/nrf52_connect_write_ios.png
.. figure:: images/nrf52_connect_write_ios.png
:alt: nRF Connect for Mobile - Write Value window

nRF Connect for Mobile - Write Value window
Expand All @@ -222,7 +217,7 @@ To perform tests, complete the following steps:
The text is sent through the |DK| to your mobile device over a Bluetooth LE link.
The device displays the text in the nRF Connect for Mobile log:

.. figure:: ../nrf52/images/nrf52_connect_log_ios.png
.. figure:: images/nrf52_connect_log_ios.png
:alt: nRF Connect for Mobile - Text shown in the log

nRF Connect for Mobile - Text shown in the log
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,9 @@ Getting started with nRF5340 DK
:local:
:depth: 2

This section gets you started with your nRF5340 :term:`Development Kit (DK)` using the |NCS|.
This guide lets you evaluate the |NCS|'s support for nRF5340 :term:`Development Kit (DK)` without the need of installing the SDK.
It tells you how to install the :ref:`peripheral_uart` sample and perform a quick test of your DK.

If you have already set up your nRF5340 DK and want to learn more, see the following documentation:

* :ref:`installation` and :ref:`configuration_and_build` documentation to install the |NCS| and learn more about its development environment.
* :ref:`ug_nrf5340` documentation for more advanced topics related to the nRF5340 DK.

If you want to go through an online training course to familiarize yourself with Bluetooth Low Energy and the development of Bluetooth LE applications, enroll in the `Bluetooth LE Fundamentals course`_ in the `Nordic Developer Academy`_.

.. _nrf5340_gs_requirements:
Expand Down Expand Up @@ -72,7 +67,7 @@ The archive contains the HEX file used to program the sample to your DK.

.. |DK| replace:: nRF5340 DK

.. include:: ../nrf52/gs.rst
.. include:: /gsg_guides/nrf52_gs.rst
:start-after: program_dk_sample_start
:end-before: program_dk_sample_end

Expand All @@ -83,7 +78,7 @@ After you have programmed the sample to the DK, you can connect to it using a te
Connecting to the sample
************************

.. include:: ../nrf52/gs.rst
.. include:: /gsg_guides/nrf52_gs.rst
:start-after: uart_dk_connect_start
:end-before: uart_dk_connect_end

Expand All @@ -97,7 +92,7 @@ Testing the sample
You can test the :ref:`peripheral_uart` sample on your |DK| using the `nRF Connect for Mobile`_ application.
The test requires that you have :ref:`connected to the sample <nrf5340_gs_connecting>` and have the connected terminal emulator open.

.. include:: ../nrf52/gs.rst
.. include:: /gsg_guides/nrf52_gs.rst
:start-after: testing_dk_start
:end-before: testing_dk_end

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Getting started with nRF7002 DK
:local:
:depth: 4

This page gets you started with your nRF7002 :term:`Development Kit (DK)` using the |NCS|.
This guide lets you evaluate the |NCS|'s support for nRF7002 :term:`Development Kit (DK)` without the need of installing the SDK.
It tells you how to install the :ref:`wifi_scan_sample` sample and perform a quick test of your DK.


If you have already set up your nRF7002 DK and want to learn more, see the following documentation:

* :ref:`installation` and :ref:`configuration_and_build` documentation to install the |NCS| and learn more about its development environment.
Expand Down Expand Up @@ -226,7 +227,7 @@ To program the precompiled sample to your development kit, complete the followin

#. Click **SELECT DEVICE** and select the DK from the drop-down list.

.. figure:: ../nrf70/images/nRF7002_programmer_select_device.png
.. figure:: images/nRF7002_programmer_select_device.png
:alt: Programmer - Select Device

Programmer - Select Device
Expand Down Expand Up @@ -274,7 +275,7 @@ The test requires that you have :ref:`connected to the sample <nrf70_gs_connecti

After successful programming of the sample onto the nRF7002 DK, scan results output will be shown in the terminal emulator connected to the sample through CDC-UART.

.. figure:: ../nrf70/images/nRF7002_scan_sample_output.png
.. figure:: images/nRF7002_scan_sample_output.png
:alt: Scan sample output

Scan sample output
Expand Down Expand Up @@ -348,3 +349,4 @@ See the following links for where to go next:

* :ref:`installation` and :ref:`configuration_and_build` documentation to install the |NCS| and learn more about its development environment.
* :ref:`ug_nrf70_developing` documentation for more advanced topics related to the nRF70 Series.
* :ref:`ug_wifi` documentation for information related to Wi-Fi protocol and Wi-Fi modes of operation.
File renamed without changes.
Loading

0 comments on commit 3a2bfab

Please sign in to comment.