Skip to content

Commit

Permalink
doc: new top level hierarchy
Browse files Browse the repository at this point in the history
Created new top level hierarchy pages.
Moved existing pages without editing their contents.
Updated include paths and redirects.
This is the first task of the rework planned in NCSDK-22319.
Page tags and links will be updated in the next PR.
NCSDK-22320.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
  • Loading branch information
greg-fer authored and rlubos committed Jun 28, 2023
1 parent aaa6aa3 commit 43b92e6
Show file tree
Hide file tree
Showing 225 changed files with 356 additions and 228 deletions.
6 changes: 3 additions & 3 deletions applications/machine_learning/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Other build types are covered by dedicated files with the build type added as a
For example, the ``release`` build type file name is :file:`prj_release.conf`.
If a board has other configuration files, for example associated with partition layout or child image configuration, these follow the same pattern.

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_overview_start
:end-before: build_types_overview_end

Expand Down Expand Up @@ -367,14 +367,14 @@ Before you start testing the application, you can select one of the :ref:`nrf_ma
Selecting a build type in |VSC|
-------------------------------

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_selection_vsc_start
:end-before: build_types_selection_vsc_end

Selecting a build type from command line
----------------------------------------

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_selection_cmd_start
:end-before: build_types_selection_cmd_end

Expand Down
6 changes: 3 additions & 3 deletions applications/matter_weather_station/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Other build types are covered by dedicated files with the build type added as a
For example, the ``release`` build type file name is :file:`prj_release.conf`.
If a board has other configuration files, for example associated with partition layout or child image configuration, these follow the same pattern.

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_overview_start
:end-before: build_types_overview_end

Expand Down Expand Up @@ -171,14 +171,14 @@ Before you start testing the application, you can select one of the :ref:`matter
Selecting a build type in |VSC|
-------------------------------

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_selection_vsc_start
:end-before: build_types_selection_vsc_end

Selecting a build type from command line
----------------------------------------

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_selection_cmd_start
:end-before: For example, you can replace the

Expand Down
2 changes: 1 addition & 1 deletion applications/nrf5340_audio/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Feature support matrix
.. note::
Features not listed are not supported.

.. include:: /software_maturity.rst
.. include:: /releases_and_maturity/software_maturity.rst
:start-after: software_maturity_application_nrf5340audio_table:
:end-before: software_maturity_protocol

Expand Down
6 changes: 3 additions & 3 deletions applications/nrf_desktop/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ Other build types are covered by dedicated files with the build type added as a
For example, the ``release`` build type file name is :file:`prj_release.conf`.
If a board has other configuration files, for example associated with partition layout or child image configuration, these follow the same pattern.

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_overview_start
:end-before: build_types_overview_end

Expand Down Expand Up @@ -850,14 +850,14 @@ Before you start testing the application, you can select one of the :ref:`nrf_de
Selecting a build type in |VSC|
-------------------------------

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_selection_vsc_start
:end-before: build_types_selection_vsc_end

Selecting a build type from command line
----------------------------------------

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_selection_cmd_start
:end-before: build_types_selection_cmd_end

Expand Down
6 changes: 3 additions & 3 deletions applications/zigbee_weather_station/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Other build types are covered by dedicated files with the build type added as a
For example, the ``release`` build type file name is :file:`prj_release.conf`.
If a board has other configuration files, for example associated with partition layout or child image configuration, these follow the same pattern.

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_overview_start
:end-before: build_types_overview_end

Expand Down Expand Up @@ -195,14 +195,14 @@ Before you start testing the application, you can select one of the :ref:`zigbee
Selecting a build type in |VSC|
-------------------------------

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_selection_vsc_start
:end-before: build_types_selection_vsc_end

Selecting a build type from command line
----------------------------------------

.. include:: /getting_started/modifying.rst
.. include:: /config_and_build/modifying.rst
:start-after: build_types_selection_cmd_start
:end-before: For example, you can replace the

Expand Down
157 changes: 105 additions & 52 deletions doc/_utils/redirects.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,50 +17,86 @@
"""

NRF = [
("app_boards", "app_dev/board_support/index"),
("ug_bootloader", "app_dev/bootloaders_and_dfu/bootloader"),
("ug_bootloader_adding", "app_dev/bootloaders_and_dfu/bootloader_adding"),
("ug_bootloader_config", "app_dev/bootloaders_and_dfu/bootloader_config"),
("ug_bootloader_external_flash", "app_dev/bootloaders_and_dfu/bootloader_external_flash"),
("ug_bootloader_testing", "app_dev/bootloaders_and_dfu/bootloader_testing"),
("ug_fw_update", "app_dev/bootloaders_and_dfu/fw_update"),
("app_bootloaders", "app_dev/bootloaders_and_dfu/index"),
("ug_logging", "app_dev/logging/index"),
("ug_multi_image", "app_dev/multi_image/index"),
("app_opt", "app_dev/optimizing/index"),
("app_memory", "app_dev/optimizing/memory"),
("app_power_opt", "app_dev/optimizing/power"),
("ug_pinctrl", "app_dev/pin_control/index"),
("ug_unity_testing", "app_dev/testing_unity_cmock/index"),
("ug_tfm", "app_dev/tfm/index"),
("app_build_system", "app_dev/build_and_config_system/index"),
("ug_radio_coex", "app_dev/wifi_coex/index"),
("ug_radio_fem", "app_dev/working_with_fem/index"),
("ug_dev_model", "dev_model"),
("dm_adding_code", "developing/adding_code"),
("dm_code_base", "developing/code_base"),
("dm_managing_code", "developing/managing_code"),
("dm_ncs_distro", "developing/ncs_distro"),
("app_boards", "config_and_build/board_support"),
("app_dev/board_support/index", "config_and_build/board_support"),
("ug_bootloader", "config_and_build/bootloaders_and_dfu/bootloader"),
("app_dev/bootloaders_and_dfu/bootloader", "config_and_build/bootloaders_and_dfu/bootloader"),
("ug_bootloader_adding", "config_and_build/bootloaders_and_dfu/bootloader_adding"),
("app_dev/bootloaders_and_dfu/bootloader_adding", "config_and_build/bootloaders_and_dfu/bootloader_adding"),
("ug_bootloader_config", "config_and_build/bootloaders_and_dfu/bootloader_config"),
("app_dev/bootloaders_and_dfu/bootloader_config", "config_and_build/bootloaders_and_dfu/bootloader_config"),
("ug_bootloader_external_flash", "config_and_build/bootloaders_and_dfu/bootloader_external_flash"),
("app_dev/bootloaders_and_dfu/bootloader_external_flash", "config_and_build/bootloaders_and_dfu/bootloader_external_flash"),
("ug_bootloader_testing", "config_and_build/bootloaders_and_dfu/bootloader_testing"),
("app_dev/bootloaders_and_dfu/bootloader_testing", "config_and_build/bootloaders_and_dfu/bootloader_testing"),
("ug_fw_update", "config_and_build/bootloaders_and_dfu/fw_update"),
("app_dev/bootloaders_and_dfu/fw_update", "config_and_build/bootloaders_and_dfu/fw_update"),
("app_bootloaders", "config_and_build/bootloaders_and_dfu/index"),
("app_dev/bootloaders_and_dfu/index", "config_and_build/bootloaders_and_dfu/index"),
("ug_logging", "test_and_optimize/logging"),
("app_dev/logging/index", "test_and_optimize/logging"),
("ug_multi_image", "config_and_build/multi_image"),
("app_dev/multi_image/index", "config_and_build/multi_image"),
("app_opt", "test_and_optimize/optimizing/index"),
("app_dev/optimizing/index", "test_and_optimize/optimizing/index"),
("app_memory", "test_and_optimize/optimizing/memory"),
("app_dev/optimizing/memory", "test_and_optimize/optimizing/memory"),
("app_power_opt", "test_and_optimize/optimizing/power"),
("app_dev/optimizing/power", "test_and_optimize/optimizing/power"),
("ug_pinctrl", "device_guides/pin_control"),
("app_dev/pin_control/index", "device_guides/pin_control"),
("ug_unity_testing", "test_and_optimize/testing_unity_cmock"),
("app_dev/testing_unity_cmock/index", "test_and_optimize/testing_unity_cmock"),
("ug_tfm", "security/tfm"),
("app_dev/tfm/index", "security/tfm"),
("app_build_system", "config_and_build/config_and_build_system"),
("app_dev/build_and_config_system/index", "config_and_build/config_and_build_system"),
("ug_radio_coex", "device_guides/wifi_coex"),
("app_dev/wifi_coex/index", "device_guides/wifi_coex"),
("ug_radio_fem", "device_guides/working_with_fem"),
("app_dev/working_with_fem/index", "device_guides/working_with_fem"),
("ug_dev_model", "releases_and_maturity/dev_model"),
("dev_model", "releases_and_maturity/dev_model"),
("dm_adding_code", "releases_and_maturity/developing/adding_code"),
("developing/adding_code", "releases_and_maturity/developing/adding_code"),
("dm_code_base", "releases_and_maturity/developing/code_base"),
("developing/code_base", "releases_and_maturity/developing/code_base"),
("dm_managing_code", "releases_and_maturity/developing/managing_code"),
("developing/managing_code", "releases_and_maturity/developing/managing_code"),
("dm_ncs_distro", "releases_and_maturity/developing/ncs_distro"),
("developing/ncs_distro", "releases_and_maturity/developing/ncs_distro"),
("doc_build", "documentation/build"),
("doc_build_process", "documentation/build_process"),
("doc_structure", "documentation/structure"),
("doc_styleguide", "documentation/styleguide"),
("doc_templates", "documentation/templates"),
("glossary", "documentation/glossary"),
("ug_bt_fast_pair", "external_comp/bt_fast_pair"),
("ug_edge_impulse", "external_comp/edge_impulse"),
("ug_memfault", "external_comp/memfault"),
("ug_nrf_cloud", "external_comp/nrf_cloud"),
("gs_assistant", "getting_started/assistant"),
("gs_installing", "getting_started/installing"),
("gs_modifying", "getting_started/modifying"),
("gs_programming", "getting_started/programming"),
("gs_recommended_versions", "getting_started/recommended_versions"),
("gs_testing", "getting_started/testing"),
("gs_updating", "getting_started/updating"),
("ug_nrf52", "nrf52"),
("ug_nrf53", "nrf53"),
("ug_nrf70", "nrf70"),
("ug_nrf91", "nrf91"),
("gs_assistant", "installation/assistant"),
("getting_started/assistant", "installation/assistant"),
("gs_installing", "installation/installing"),
("getting_started/installing", "installation/installing"),
("gs_modifying", "config_and_build/modifying"),
("getting_started/modifying", "config_and_build/modifying"),
("gs_programming", "config_and_build/programming"),
("getting_started/programming", "config_and_build/programming"),
("gs_recommended_versions", "installation/recommended_versions"),
("getting_started/recommended_versions", "installation/recommended_versions"),
("gs_testing", "test_and_optimize/testing"),
("getting_started/testing", "test_and_optimize/testing"),
("gs_updating", "installation/updating"),
("getting_started/updating", "installation/updating"),
("ug_nrf52", "device_guides/nrf52"),
("nrf52", "device_guides/nrf52"),
("ug_nrf53", "device_guides/nrf53"),
("nrf53", "device_guides/nrf53"),
("ug_nrf70", "device_guides/nrf70"),
("nrf70", "device_guides/nrf70"),
("ug_nrf91", "device_guides/nrf91"),
("nrf91", "device_guides/nrf91"),
("ug_ble_controller", "protocols/ble/index"),
("ug_bt_mesh_architecture", "protocols/bt_mesh/architecture"),
("ug_bt_mesh_concepts", "protocols/bt_mesh/concepts"),
Expand Down Expand Up @@ -149,21 +185,38 @@
("samples/samples_thread","samples/thread"),
("samples/samples_wifi","samples/wifi"),
("samples/samples_zigbee","samples/zigbee"),
("security_chapter","security"),
("ug_nrf52_developing","working_with_nrf/nrf52/developing"),
("ug_nrf52_features","working_with_nrf/nrf52/features"),
("ug_nrf52_gs","working_with_nrf/nrf52/gs"),
("ug_nrf5340","working_with_nrf/nrf53/nrf5340"),
("ug_thingy53","working_with_nrf/nrf53/thingy53"),
("ug_thingy53_gs","working_with_nrf/nrf53/thingy53_gs"),
("ug_nrf7002_constrained","working_with_nrf/nrf70/developing/constrained"),
("ug_nrf70_developing","working_with_nrf/nrf70/developing/index"),
("ug_nrf70_developing_powersave","working_with_nrf/nrf70/developing/powersave"),
("ug_nrf70_features","working_with_nrf/nrf70/features"),
("ug_nrf7002_gs","working_with_nrf/nrf70/gs"),
("ug_nrf9160","working_with_nrf/nrf91/nrf9160"),
("ug_nrf9160_gs","working_with_nrf/nrf91/nrf9160_gs"),
("ug_nrf91_features","working_with_nrf/nrf91/nrf91_features"),
("ug_thingy91","working_with_nrf/nrf91/thingy91"),
("ug_thingy91_gsg","working_with_nrf/nrf91/thingy91_gsg"),
("security_chapter","security/security"),
("security","security/security"),
("ug_nrf52_developing","device_guides/working_with_nrf/nrf52/developing"),
("working_with_nrf/nrf52/developing","device_guides/working_with_nrf/nrf52/developing"),
("ug_nrf52_features","device_guides/working_with_nrf/nrf52/features"),
("working_with_nrf/nrf52/features","device_guides/working_with_nrf/nrf52/features"),
("ug_nrf52_gs","device_guides/working_with_nrf/nrf52/gs"),
("working_with_nrf/nrf52/gs","device_guides/working_with_nrf/nrf52/gs"),
("ug_nrf5340","device_guides/working_with_nrf/nrf53/nrf5340"),
("working_with_nrf/nrf53/nrf5340","device_guides/working_with_nrf/nrf53/nrf5340"),
("ug_thingy53","device_guides/working_with_nrf/nrf53/thingy53"),
("working_with_nrf/nrf53/thingy53","device_guides/working_with_nrf/nrf53/thingy53"),
("ug_thingy53_gs","device_guides/working_with_nrf/nrf53/thingy53_gs"),
("working_with_nrf/nrf53/thingy53_gs","device_guides/working_with_nrf/nrf53/thingy53_gs"),
("ug_nrf7002_constrained","device_guides/working_with_nrf/nrf70/developing/constrained"),
("working_with_nrf/nrf70/developing/constrained","device_guides/working_with_nrf/nrf70/developing/constrained"),
("ug_nrf70_developing","device_guides/working_with_nrf/nrf70/developing/index"),
("working_with_nrf/nrf70/developing/index","device_guides/working_with_nrf/nrf70/developing/index"),
("ug_nrf70_developing_powersave","device_guides/working_with_nrf/nrf70/developing/powersave"),
("working_with_nrf/nrf70/developing/powersave","device_guides/working_with_nrf/nrf70/developing/powersave"),
("ug_nrf70_features","device_guides/working_with_nrf/nrf70/features"),
("working_with_nrf/nrf70/features","device_guides/working_with_nrf/nrf70/features"),
("ug_nrf7002_gs","device_guides/working_with_nrf/nrf70/gs"),
("working_with_nrf/nrf70/gs","device_guides/working_with_nrf/nrf70/gs"),
("ug_nrf9160","device_guides/working_with_nrf/nrf91/nrf9160"),
("working_with_nrf/nrf91/nrf9160","device_guides/working_with_nrf/nrf91/nrf9160"),
("ug_nrf9160_gs","device_guides/working_with_nrf/nrf91/nrf9160_gs"),
("working_with_nrf/nrf91/nrf9160_gs","device_guides/working_with_nrf/nrf91/nrf9160_gs"),
("ug_nrf91_features","device_guides/working_with_nrf/nrf91/nrf91_features"),
("working_with_nrf/nrf91/nrf91_features","device_guides/working_with_nrf/nrf91/nrf91_features"),
("ug_thingy91","device_guides/working_with_nrf/nrf91/thingy91"),
("working_with_nrf/nrf91/thingy91","device_guides/working_with_nrf/nrf91/thingy91"),
("ug_thingy91_gsg","device_guides/working_with_nrf/nrf91/thingy91_gsg"),
("working_with_nrf/nrf91/thingy91_gsg","device_guides/working_with_nrf/nrf91/thingy91_gsg"),
]
23 changes: 0 additions & 23 deletions doc/nrf/app_dev.rst

This file was deleted.

24 changes: 24 additions & 0 deletions doc/nrf/config_and_build.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _ug_app_dev:
.. _config_and_build:

Configuration and building
##########################

The |NCS| build and configuration system is based on the one from Zephyr, with some additions.

The guides in this section provide universal build and configuration steps valid for :ref:`all supported boards <app_boards>`.
Depending on the board you are working with, check also its :ref:`hardware guide <device_guides>`, as some nRF Series families have specific exceptions and rules to be applied on top of the general configuration procedures.

Make sure to consider :ref:`app_bootloaders` already at this stage of the application development.

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

config_and_build/config_and_build_system
config_and_build/board_support
config_and_build/pin_control
config_and_build/programming
config_and_build/modifying
config_and_build/multi_image
config_and_build/bootloaders_and_dfu/index
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The most common use cases for builds composed of multiple images are application
What image files are
********************

.. include:: ../build_and_config_system/index.rst
.. include:: config_and_build_system.rst
:start-after: output_build_files_info_start
:end-before: output_build_files_info_end

Expand All @@ -30,7 +30,7 @@ Using multiple images has the following advantages:
This is useful for bootloader images, which can require their own copy of a library that the application uses, but in a different version or configuration.
* In multi-core builds, the build configuration of a child image in a separate core can be made known to the parent image.

.. include:: ../build_and_config_system/index.rst
.. include:: config_and_build_system.rst
:start-after: output_build_files_table_start
:end-before: output_build_files_table_end

Expand Down Expand Up @@ -239,7 +239,7 @@ With west, you can pass these configuration variables into CMake by using the ``
You can make a project pass Kconfig configuration files, fragments, and devicetree overlays to child images by placing them in the :file:`child_image` folder in the application source directory.
The listing below describes how to leverage this functionality, where ``ACI_NAME`` is the name of the child image to which the configuration will be applied.

.. literalinclude:: ../../../../cmake/multi_image.cmake
.. literalinclude:: ../../../cmake/multi_image.cmake
:language: c
:start-at: It is possible for a sample to use a custom set of Kconfig fragments for a
:end-before: set(ACI_CONF_DIR ${APPLICATION_CONFIG_DIR}/child_image)
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ After completing the :ref:`manual <build_environment_cli>` or :ref:`automatic <g

If you have installed the |NCS| using the :ref:`Toolchain Manager <gs_app_tcm>`, click the down arrow next to the version you installed and select :guilabel:`Open bash`.

.. figure:: images/gs-assistant_tm_dropdown.png
.. figure:: ../installation/images/gs-assistant_tm_dropdown.png
:alt: The Toolchain Manager dropdown menu for the installed nRF Connect SDK version, cropped

The Toolchain Manager dropdown menu options
Expand Down
Loading

0 comments on commit 43b92e6

Please sign in to comment.