Skip to content

Commit dd150d3

Browse files
greg-ferrlubos
authored andcommitted
doc: gsg: remove nRF52 and nRF5340 start guides
Removed the nRF52 Series Getting Started Guide. Removed the nRF5340 Getting Started Guide. These guides are now replaced by the Quick Start app. Reworked the getting started landing page to Quick Start page. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent d081c40 commit dd150d3

File tree

17 files changed

+75
-386
lines changed

17 files changed

+75
-386
lines changed

doc/_utils/redirects.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,15 @@
3232
("ug_nrf7002_gs", "gsg_guides/nrf7002_gs"), # Getting started with nRF7002 DK
3333
("working_with_nrf/nrf70/gs", "gsg_guides/nrf7002_gs"),
3434
("device_guides/working_with_nrf/nrf70/gs", "gsg_guides/nrf7002_gs"),
35-
("device_guides/working_with_nrf/nrf53/nrf5340_gs", "gsg_guides/nrf5340_gs"), # Getting started with nRF5340 DK
35+
("device_guides/working_with_nrf/nrf53/nrf5340_gs", "gsg_guides"), # Getting started with nRF5340 DK (removed in v2.8.0)
36+
("gsg_guides/nrf5340_gs", "gsg_guides"),
3637
("ug_thingy53_gs", "gsg_guides/thingy53_gs"), # Getting started with Thingy:53
3738
("working_with_nrf/nrf53/thingy53_gs", "gsg_guides/thingy53_gs"),
3839
("device_guides/working_with_nrf/nrf53/thingy53_gs", "gsg_guides/thingy53_gs"),
39-
("ug_nrf52_gs", "gsg_guides/nrf52_gs"), # Getting started with nRF52 Series
40-
("working_with_nrf/nrf52/gs", "gsg_guides/nrf52_gs"),
41-
("device_guides/working_with_nrf/nrf52/gs", "gsg_guides/nrf52_gs"),
40+
("ug_nrf52_gs", "gsg_guides"), # Getting started with nRF52 Series (removed in v2.8.0)
41+
("working_with_nrf/nrf52/gs", "gsg_guides"),
42+
("device_guides/working_with_nrf/nrf52/gs", "gsg_guides"),
43+
("gsg_guides/nrf52_gs", "gsg_guides"),
4244
("gs_assistant", "installation/install_ncs"), # Installing the nRF Connect SDK
4345
("getting_started", "installation"),
4446
("getting_started/assistant", "installation/install_ncs"),

doc/_zoomin/ncs.tags.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,13 @@ mapping_topics:
2424
- nrf/gsg_guides/thingy91_gsg.html: ["nrf91-series", "thingy91", "nrf9160", "nrf52840", "lte",
2525
"prototyping-platforms"]
2626
- nrf/gsg_guides/nrf7002_gs.html: ["nrf70-series", "nrf7002", "development-kits"]
27-
- nrf/gsg_guides/nrf5340_gs.html: ["nrf53-series", "nrf5340", "development-kits"]
2827
- nrf/gsg_guides/thingy53_gs.html: ["nrf53-series", "thingy53", "prototyping-platforms"]
29-
- nrf/gsg_guides/nrf52_gs.html: ["nrf52-series", "development-kits", "nrf52840", "nrf52833",
30-
"nrf52832", "nrf52820", "nrf52811", "nrf52810", "nrf52805"]
31-
- nrf/gsg_guides/gsg_other.html: ["nrf9161", "nrf9151", "development-kits", "npm1300", "nrf54h20",
32-
"nrf54l15", "nrf7002", "evaluation-kits", "pmic"]
28+
- nrf/gsg_guides/gsg_other.html: ["nrf52-series", "nrf52840", "nrf52833",
29+
"nrf52832", "nrf52820", "nrf52811", "nrf52810", "nrf52805",
30+
"nrf53-series", "nrf5340", "thingy53", "nrf9161",
31+
"nrf9160", "nrf9151", "thingy91", "development-kits",
32+
"npm1300", "nrf54h20", "nrf54l15", "nrf7002", "evaluation-kits",
33+
"pmic"]
3334
- nrf/installation.html: ["nrf91-series", "nrf70-series", "nrf54-series", "nrf53-series",
3435
"nrf52-series", "nrf7002", "nrf7001", "nrf7000", "nrf9160", "thingy91",
3536
"nrf9161", "nrf9151", "nrf9131", "nrf54h20", "nrf54l15", "nrf5340",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ Features of nRF52 Series
1010
The nRF52 Series of System-on-Chip (SoC) devices embed an Arm Cortex-M4 processor with Nordic Semiconductor's 2.4 GHz RF transceivers.
1111
All of the nRF52 Series SoCs have support for Bluetooth® 5 features, in addition to multiprotocol capabilities.
1212

13+
To get started with the nRF52 Series, download and run the `Quick Start`_ application from `nRF Connect for Desktop`_.
14+
1315
For additional information, see the following documentation:
1416

1517
* `nRF52 Series`_ for the technical documentation on the nRF52 Series chips and associated kits.
16-
* :ref:`ug_nrf52_gs`.
1718
* :ref:`ug_nrf52` for more advanced topics related to the nRF52 Series.
1819
* :ref:`installation` and :ref:`configuration_and_build` documentation to install the |NCS| and learn more about its development environment.
1920

doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ Features of nRF53 Series
1010
The nRF53 Series System-on-Chips (SoC) integrate a high-performance Arm® Cortex®-M33 dual-core processor with a 2.4 GHz RF transceiver, in addition to advanced security features.
1111
All nRF53 Series SoC support Bluetooth® 5.1 and Bluetooth Mesh, in addition to multiprotocol capabilities.
1212

13+
To get started with the nRF5340 DK, download and run the `Quick Start`_ application from `nRF Connect for Desktop`_.
14+
1315
For additional information, refer to the following resources:
1416

1517
* `nRF53 Series`_ for the technical documentation on the nRF53 Series chips and associated kits.
1618
* :ref:`installation` and :ref:`configuration_and_build` documentation to install the |NCS| and learn more about its development environment.
17-
* :ref:`ug_nrf5340_gs` guide for getting started with the nRF5340 DK.
1819
* :ref:`ug_thingy53_gs` for getting started with the Thingy:53.
1920

2021
Dual-core architecture

doc/nrf/app_dev/device_guides/nrf70/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,28 +35,28 @@ Zephyr and the |NCS| provide support for developing networking applications with
3535
- PCA10095
3636
- ``nrf5340dk/nrf5340/cpuapp``
3737
- | `Product Specification <nRF5340 Product Specification_>`_
38-
| :ref:`Getting started <ug_nrf5340_gs>`
38+
| `Quick Start`_
3939
| `User Guide <nRF5340 DK User Guide_>`_
4040
* - :ref:`zephyr:nrf52840dk_nrf52840`
4141
- nRF7002 EK
4242
- PCA10056
4343
- ``nrf52840dk/nrf52840``
4444
- | `Product Specification <nRF52840 Product Specification_>`_
45-
| :ref:`Getting started <ug_nrf52_gs>`
45+
| `Quick Start`_
4646
| `User Guide <nRF52840 DK User Guide_>`_
4747
* - :ref:`zephyr:nrf9151dk_nrf9151`
4848
- nRF7002 EK
4949
- PCA10171
5050
- ``nrf9151dk/nrf9151/ns``
5151
- | `Product Specification <nRF9151 Product Specification_>`_
52-
| :ref:`Getting started <gsg_other>`
52+
| `Quick Start`_
5353
| `User Guide <nRF9151 DK Hardware_>`_
5454
* - :ref:`zephyr:nrf9161dk_nrf9161`
5555
- nRF7002 EK
5656
- PCA10153
5757
- ``nrf9161dk/nrf9161/ns``
5858
- | `Product Specification <nRF9161 Product Specification_>`_
59-
| :ref:`Getting started <gsg_other>`
59+
| `Quick Start`_
6060
| `User Guide <nRF9161 DK Hardware_>`_
6161
* - :ref:`zephyr:nrf9160dk_nrf9160`
6262
- nRF7002 EK

doc/nrf/app_dev/device_guides/nrf91/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Zephyr and the |NCS| provide support for developing cellular applications using
2525
- PCA10153
2626
- ``nrf9161dk/nrf9161``, ``nrf9161dk/nrf9161/ns``
2727
- | `Product Specification <nRF9161 Product Specification_>`_
28-
| :ref:`Getting started <gsg_other>`
28+
| `Quick Start`_
2929
| `User Guide <nRF9161 DK Hardware_>`_
3030
- | `nRF9161 DK product page`_
3131
| `nRF9161 System in Package (SiP) <nRF9161 product website_>`_
@@ -41,7 +41,7 @@ Zephyr and the |NCS| provide support for developing cellular applications using
4141
- PCA10171
4242
- ``nrf9151dk/nrf9151``, ``nrf9151dk/nrf9151/ns``
4343
- | `Product Specification <nRF9151 Product Specification_>`_
44-
| :ref:`Getting started <gsg_other>`
44+
| `Quick Start`_
4545
| `User Guide <nRF9151 DK Hardware_>`_
4646
- | `nRF9151 DK product page`_
4747
| `nRF9151 System in Package (SiP) <nRF9151 product website_>`_

doc/nrf/app_dev/device_guides/pmic/npm1300.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,21 @@ The following boards in the `Zephyr`_ open source project and in the |NCS| are c
6464
- PCA10095
6565
- ``nrf5340dk/nrf5340/cpuapp``
6666
- | `Product Specification <nRF5340 Product Specification_>`_
67-
| :ref:`Getting started <ug_nrf5340_gs>`
67+
| `Quick Start`_
6868
| `User Guide <nRF5340 DK User Guide_>`_
6969
* - :ref:`zephyr:nrf52840dk_nrf52840`
7070
- nPM1300 EK
7171
- PCA10056
7272
- ``nrf52840dk/nrf52840``
7373
- | `Product Specification <nRF52840 Product Specification_>`_
74-
| :ref:`Getting started <ug_nrf52_gs>`
74+
| `Quick Start`_
7575
| `User Guide <nRF52840 DK User Guide_>`_
7676
* - :ref:`zephyr:nrf52dk_nrf52832`
7777
- nPM1300 EK
7878
- PCA10040
7979
- ``nrf52dk/nrf52832``
8080
- | `Product Specification <nRF52832 Product Specification_>`_
81-
| :ref:`Getting started <ug_nrf52_gs>`
81+
| `Quick Start`_
8282
| `User Guide <nRF52 DK User Guide_>`_
8383
8484
PMIC samples and libraries

doc/nrf/gsg_guides.rst

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,52 @@
11
.. _gsg_guides:
2+
.. _ug_nrf52_gs:
3+
.. _ug_nrf5340_gs:
24

3-
Getting started guides
4-
######################
5+
Quick Start
6+
###########
57

6-
Use the guides in this section to familiarize yourself with the |NCS| tools and components for some of the devices supported by the SDK.
8+
.. quick_start_table_start
79
8-
.. important::
9-
For the full list of devices supported in the |NCS|, see the :ref:`board support pages <programming_board_names>`.
10-
11-
These guides do not require installing the |NCS|.
12-
They provide a guided experience using Nordic Semiconductor tools and precompiled binaries.
10+
Use the `Quick Start`_ app, available from `nRF Connect for Desktop`_, to familiarize yourself with the |NCS| tools and components for some of the devices supported by the |NCS|.
11+
The application uses Nordic Semiconductor tools and precompiled binaries and does not require installing the |NCS|.
1312

14-
This is not a comprehensive section that includes all of the available getting started guides for Nordic Semiconductor devices.
15-
16-
.. note::
17-
* To get started with the nRF91x1 DKs and the nRF54L15 PDK, complete the steps in the `Quick Start`_ app, available from `nRF Connect for Desktop`_.
18-
* To get started with the nRF54H20 DK, the installation of the |NCS| is required.
19-
See :ref:`ug_nrf54h20_gs`.
20-
* To get started with the nPM1300 EK, see the `Get started <nPM1300 EK get started_>`_ section of the nPM1300 EK product page.
21-
* To get started with the nRF7002 EB, see the `Get started <nRF7002 EB get started_>`_ section of the nRF7002 EB product page.
13+
.. important::
14+
The following table does not list all devices supported in the |NCS|.
15+
For the full list, see the :ref:`board support pages <programming_board_names>`.
16+
17+
+----------------------+----------------------------------------------------------------+--------------------------------+
18+
| Device | Getting started method | Device user guide |
19+
+======================+================================================================+================================+
20+
| nRF9161 DK | | `nRF9161 DK Hardware`_ |
21+
+----------------------+ +--------------------------------+
22+
| nRF9160 DK | | `nRF9160 DK Hardware`_ |
23+
+----------------------+ +--------------------------------+
24+
| nRF9151 DK | | `nRF9151 DK Hardware`_ |
25+
+----------------------+ +--------------------------------+
26+
| nRF54L15 DK | `Quick Start`_ app | *Not yet available* |
27+
+----------------------+ +--------------------------------+
28+
| nRF5340 DK | | `nRF5340 DK User Guide`_ |
29+
+----------------------+ +--------------------------------+
30+
| nRF52840 DK | | `nRF52840 DK User Guide`_ |
31+
+----------------------+ +--------------------------------+
32+
| nRF52833 DK | | `nRF52833 DK User Guide`_ |
33+
+----------------------+ +--------------------------------+
34+
| nRF52 DK | | `nRF52 DK User Guide`_ |
35+
+----------------------+----------------------------------------------------------------+--------------------------------+
36+
| nRF54H20 DK | :ref:`ug_nrf54h20_gs` - *Quick Start support coming soon* | *Not yet available* |
37+
+----------------------+----------------------------------------------------------------+--------------------------------+
38+
| nRF7002 DK | :ref:`ug_nrf7002_gs` | `nRF7002 DK Hardware`_ |
39+
+----------------------+----------------------------------------------------------------+--------------------------------+
40+
| nRF7002 EB | `Get started <nRF7002 EB get started_>`_ on the product page | `nRF7002 EB User Guide`_ |
41+
+----------------------+----------------------------------------------------------------+--------------------------------+
42+
| Thingy:91 | :ref:`ug_thingy91_gsg` | `Nordic Thingy:91 User Guide`_ |
43+
+----------------------+----------------------------------------------------------------+--------------------------------+
44+
| Thingy:53 | :ref:`ug_thingy53_gs` | `Nordic Thingy:53 Hardware`_ |
45+
+----------------------+----------------------------------------------------------------+--------------------------------+
46+
| nPM1300 EK | `Get started <nPM1300 EK get started_>`_ on the product page | `nPM1300 EK User Guide`_ |
47+
+----------------------+----------------------------------------------------------------+--------------------------------+
48+
49+
.. quick_start_table_end
2250
2351
.. toctree::
2452
:maxdepth: 1
@@ -27,7 +55,5 @@ This is not a comprehensive section that includes all of the available getting s
2755
gsg_guides/nrf9160_gs
2856
gsg_guides/thingy91_gsg
2957
gsg_guides/nrf7002_gs
30-
gsg_guides/nrf5340_gs
3158
gsg_guides/thingy53_gs
32-
gsg_guides/nrf52_gs
3359
gsg_guides/gsg_other

doc/nrf/gsg_guides/gsg_other.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
.. _gsg_other:
22

3+
34
Getting started with other DKs
45
##############################
56

6-
Use the following guides to familiarize yourself with the |NCS| tools and components for the following devices supported by the SDK:
7-
8-
* To get started with the nRF91x1 DKs and the nRF54L15 PDK, complete the steps in the `Quick Start`_ app, available from `nRF Connect for Desktop`_.
9-
* To get started with the nRF54H20 DK, see :ref:`ug_nrf54h20_gs`.
10-
* To get started with the nPM1300 EK, see the `Get started <nPM1300 EK get started_>`_ section of the nPM1300 EK product page.
11-
* To get started with the nRF7002 EB, see the `Get started <nRF7002 EB get started_>`_ section of the nRF7002 EB product page.
7+
.. include:: ../gsg_guides.rst
8+
:start-after: quick_start_table_start
9+
:end-before: quick_start_table_end
-163 KB
Binary file not shown.

0 commit comments

Comments
 (0)