diff --git a/applications/machine_learning/README.rst b/applications/machine_learning/README.rst index aba887e8a4a8..96a93b475de9 100644 --- a/applications/machine_learning/README.rst +++ b/applications/machine_learning/README.rst @@ -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 @@ -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 diff --git a/applications/matter_weather_station/README.rst b/applications/matter_weather_station/README.rst index e1432a2e51c8..26370b3f4883 100644 --- a/applications/matter_weather_station/README.rst +++ b/applications/matter_weather_station/README.rst @@ -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 @@ -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 diff --git a/applications/nrf5340_audio/README.rst b/applications/nrf5340_audio/README.rst index 17b9d587195d..40b094d82080 100644 --- a/applications/nrf5340_audio/README.rst +++ b/applications/nrf5340_audio/README.rst @@ -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 diff --git a/applications/nrf_desktop/README.rst b/applications/nrf_desktop/README.rst index 1554a3fd8926..40e8678de869 100644 --- a/applications/nrf_desktop/README.rst +++ b/applications/nrf_desktop/README.rst @@ -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 @@ -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 diff --git a/applications/zigbee_weather_station/README.rst b/applications/zigbee_weather_station/README.rst index d4ad55925704..9812b0ce83e9 100644 --- a/applications/zigbee_weather_station/README.rst +++ b/applications/zigbee_weather_station/README.rst @@ -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 @@ -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 diff --git a/doc/_utils/redirects.py b/doc/_utils/redirects.py index ddaf324835f2..c9202d410d47 100644 --- a/doc/_utils/redirects.py +++ b/doc/_utils/redirects.py @@ -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"), @@ -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"), ] diff --git a/doc/nrf/app_dev.rst b/doc/nrf/app_dev.rst deleted file mode 100644 index f7db06fda0d9..000000000000 --- a/doc/nrf/app_dev.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. _ug_app_dev: - -Application development -####################### - -The following user guides introduce important concepts to consider when developing a new application based on the |NCS|: - -.. toctree:: - :maxdepth: 1 - :caption: Subpages: - - app_dev/board_support/index - app_dev/pin_control/index - app_dev/build_and_config_system/index - app_dev/optimizing/index - app_dev/ap_protect/index - app_dev/bootloaders_and_dfu/index - app_dev/logging/index - app_dev/multi_image/index - app_dev/testing_unity_cmock/index - app_dev/tfm/index - app_dev/working_with_fem/index - app_dev/wifi_coex/index diff --git a/doc/nrf/config_and_build.rst b/doc/nrf/config_and_build.rst new file mode 100644 index 000000000000..698d572d4b68 --- /dev/null +++ b/doc/nrf/config_and_build.rst @@ -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 `. +Depending on the board you are working with, check also its :ref:`hardware guide `, 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 diff --git a/doc/nrf/app_dev/board_support/index.rst b/doc/nrf/config_and_build/board_support.rst similarity index 100% rename from doc/nrf/app_dev/board_support/index.rst rename to doc/nrf/config_and_build/board_support.rst diff --git a/doc/nrf/app_dev/bootloaders_and_dfu/bootloader.rst b/doc/nrf/config_and_build/bootloaders_and_dfu/bootloader.rst similarity index 100% rename from doc/nrf/app_dev/bootloaders_and_dfu/bootloader.rst rename to doc/nrf/config_and_build/bootloaders_and_dfu/bootloader.rst diff --git a/doc/nrf/app_dev/bootloaders_and_dfu/bootloader_adding.rst b/doc/nrf/config_and_build/bootloaders_and_dfu/bootloader_adding.rst similarity index 100% rename from doc/nrf/app_dev/bootloaders_and_dfu/bootloader_adding.rst rename to doc/nrf/config_and_build/bootloaders_and_dfu/bootloader_adding.rst diff --git a/doc/nrf/app_dev/bootloaders_and_dfu/bootloader_config.rst b/doc/nrf/config_and_build/bootloaders_and_dfu/bootloader_config.rst similarity index 100% rename from doc/nrf/app_dev/bootloaders_and_dfu/bootloader_config.rst rename to doc/nrf/config_and_build/bootloaders_and_dfu/bootloader_config.rst diff --git a/doc/nrf/app_dev/bootloaders_and_dfu/bootloader_external_flash.rst b/doc/nrf/config_and_build/bootloaders_and_dfu/bootloader_external_flash.rst similarity index 100% rename from doc/nrf/app_dev/bootloaders_and_dfu/bootloader_external_flash.rst rename to doc/nrf/config_and_build/bootloaders_and_dfu/bootloader_external_flash.rst diff --git a/doc/nrf/app_dev/bootloaders_and_dfu/bootloader_testing.rst b/doc/nrf/config_and_build/bootloaders_and_dfu/bootloader_testing.rst similarity index 100% rename from doc/nrf/app_dev/bootloaders_and_dfu/bootloader_testing.rst rename to doc/nrf/config_and_build/bootloaders_and_dfu/bootloader_testing.rst diff --git a/doc/nrf/app_dev/bootloaders_and_dfu/fw_update.rst b/doc/nrf/config_and_build/bootloaders_and_dfu/fw_update.rst similarity index 100% rename from doc/nrf/app_dev/bootloaders_and_dfu/fw_update.rst rename to doc/nrf/config_and_build/bootloaders_and_dfu/fw_update.rst diff --git a/doc/nrf/app_dev/bootloaders_and_dfu/images/bootloader_memory_layout.svg b/doc/nrf/config_and_build/bootloaders_and_dfu/images/bootloader_memory_layout.svg similarity index 100% rename from doc/nrf/app_dev/bootloaders_and_dfu/images/bootloader_memory_layout.svg rename to doc/nrf/config_and_build/bootloaders_and_dfu/images/bootloader_memory_layout.svg diff --git a/doc/nrf/app_dev/bootloaders_and_dfu/images/bootloader_memory_layout_onestage.png b/doc/nrf/config_and_build/bootloaders_and_dfu/images/bootloader_memory_layout_onestage.png similarity index 100% rename from doc/nrf/app_dev/bootloaders_and_dfu/images/bootloader_memory_layout_onestage.png rename to doc/nrf/config_and_build/bootloaders_and_dfu/images/bootloader_memory_layout_onestage.png diff --git a/doc/nrf/app_dev/bootloaders_and_dfu/images/bootloader_memory_layout_onestage.svg b/doc/nrf/config_and_build/bootloaders_and_dfu/images/bootloader_memory_layout_onestage.svg similarity index 100% rename from doc/nrf/app_dev/bootloaders_and_dfu/images/bootloader_memory_layout_onestage.svg rename to doc/nrf/config_and_build/bootloaders_and_dfu/images/bootloader_memory_layout_onestage.svg diff --git a/doc/nrf/app_dev/bootloaders_and_dfu/index.rst b/doc/nrf/config_and_build/bootloaders_and_dfu/index.rst similarity index 100% rename from doc/nrf/app_dev/bootloaders_and_dfu/index.rst rename to doc/nrf/config_and_build/bootloaders_and_dfu/index.rst diff --git a/doc/nrf/app_dev/build_and_config_system/index.rst b/doc/nrf/config_and_build/config_and_build_system.rst similarity index 100% rename from doc/nrf/app_dev/build_and_config_system/index.rst rename to doc/nrf/config_and_build/config_and_build_system.rst diff --git a/doc/nrf/app_dev/board_support/images/spe_nspe.svg b/doc/nrf/config_and_build/images/spe_nspe.svg similarity index 100% rename from doc/nrf/app_dev/board_support/images/spe_nspe.svg rename to doc/nrf/config_and_build/images/spe_nspe.svg diff --git a/doc/nrf/getting_started/modifying.rst b/doc/nrf/config_and_build/modifying.rst similarity index 100% rename from doc/nrf/getting_started/modifying.rst rename to doc/nrf/config_and_build/modifying.rst diff --git a/doc/nrf/app_dev/multi_image/index.rst b/doc/nrf/config_and_build/multi_image.rst similarity index 99% rename from doc/nrf/app_dev/multi_image/index.rst rename to doc/nrf/config_and_build/multi_image.rst index 4757988cf724..20f434e4aa35 100644 --- a/doc/nrf/app_dev/multi_image/index.rst +++ b/doc/nrf/config_and_build/multi_image.rst @@ -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 @@ -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 @@ -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) diff --git a/doc/nrf/app_dev/pin_control/index.rst b/doc/nrf/config_and_build/pin_control.rst similarity index 100% rename from doc/nrf/app_dev/pin_control/index.rst rename to doc/nrf/config_and_build/pin_control.rst diff --git a/doc/nrf/getting_started/programming.rst b/doc/nrf/config_and_build/programming.rst similarity index 98% rename from doc/nrf/getting_started/programming.rst rename to doc/nrf/config_and_build/programming.rst index 7509800d4602..742ea2564b6c 100644 --- a/doc/nrf/getting_started/programming.rst +++ b/doc/nrf/config_and_build/programming.rst @@ -40,7 +40,7 @@ After completing the :ref:`manual ` or :ref:`automatic `, 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 diff --git a/doc/nrf/device_guides.rst b/doc/nrf/device_guides.rst new file mode 100644 index 000000000000..6614eaf5e969 --- /dev/null +++ b/doc/nrf/device_guides.rst @@ -0,0 +1,20 @@ +.. _device_guides: + +Device configuration guides +########################### + +The |NCS| provides :ref:`board support ` for all Nordic Semiconductor devices. +While the information in the :ref:`config_and_build` and :ref:`test_and_optimize` sections apply to all supported devices, the guides in this section include more specific information for each supported nRF Series family. +You can also find here guides that are strictly related to hardware features. + +.. toctree:: + :maxdepth: 1 + :caption: Subpages: + + device_guides/nrf91 + device_guides/nrf70 + device_guides/nrf53 + device_guides/nrf52 + device_guides/pmic + device_guides/working_with_fem + device_guides/wifi_coex diff --git a/doc/nrf/app_dev/wifi_coex/images/coex_generic_3pin_pta.svg b/doc/nrf/device_guides/images/coex_generic_3pin_pta.svg similarity index 100% rename from doc/nrf/app_dev/wifi_coex/images/coex_generic_3pin_pta.svg rename to doc/nrf/device_guides/images/coex_generic_3pin_pta.svg diff --git a/doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_10db_freq_input_gain.png b/doc/nrf/device_guides/images/nrf21540_builtin_model_10db_freq_input_gain.png similarity index 100% rename from doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_10db_freq_input_gain.png rename to doc/nrf/device_guides/images/nrf21540_builtin_model_10db_freq_input_gain.png diff --git a/doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_10db_freq_temp_gain.png b/doc/nrf/device_guides/images/nrf21540_builtin_model_10db_freq_temp_gain.png similarity index 100% rename from doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_10db_freq_temp_gain.png rename to doc/nrf/device_guides/images/nrf21540_builtin_model_10db_freq_temp_gain.png diff --git a/doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_10db_freq_volt_gain.png b/doc/nrf/device_guides/images/nrf21540_builtin_model_10db_freq_volt_gain.png similarity index 100% rename from doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_10db_freq_volt_gain.png rename to doc/nrf/device_guides/images/nrf21540_builtin_model_10db_freq_volt_gain.png diff --git a/doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_20db_freq_input_gain.png b/doc/nrf/device_guides/images/nrf21540_builtin_model_20db_freq_input_gain.png similarity index 100% rename from doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_20db_freq_input_gain.png rename to doc/nrf/device_guides/images/nrf21540_builtin_model_20db_freq_input_gain.png diff --git a/doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_20db_freq_temp_gain.png b/doc/nrf/device_guides/images/nrf21540_builtin_model_20db_freq_temp_gain.png similarity index 100% rename from doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_20db_freq_temp_gain.png rename to doc/nrf/device_guides/images/nrf21540_builtin_model_20db_freq_temp_gain.png diff --git a/doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_20db_freq_volt_gain.png b/doc/nrf/device_guides/images/nrf21540_builtin_model_20db_freq_volt_gain.png similarity index 100% rename from doc/nrf/app_dev/working_with_fem/images/nrf21540_builtin_model_20db_freq_volt_gain.png rename to doc/nrf/device_guides/images/nrf21540_builtin_model_20db_freq_volt_gain.png diff --git a/doc/nrf/app_dev/working_with_fem/images/nrf21540_ek.png b/doc/nrf/device_guides/images/nrf21540_ek.png similarity index 100% rename from doc/nrf/app_dev/working_with_fem/images/nrf21540_ek.png rename to doc/nrf/device_guides/images/nrf21540_ek.png diff --git a/doc/nrf/nrf52.rst b/doc/nrf/device_guides/nrf52.rst similarity index 100% rename from doc/nrf/nrf52.rst rename to doc/nrf/device_guides/nrf52.rst diff --git a/doc/nrf/nrf53.rst b/doc/nrf/device_guides/nrf53.rst similarity index 100% rename from doc/nrf/nrf53.rst rename to doc/nrf/device_guides/nrf53.rst diff --git a/doc/nrf/nrf70.rst b/doc/nrf/device_guides/nrf70.rst similarity index 100% rename from doc/nrf/nrf70.rst rename to doc/nrf/device_guides/nrf70.rst diff --git a/doc/nrf/nrf91.rst b/doc/nrf/device_guides/nrf91.rst similarity index 100% rename from doc/nrf/nrf91.rst rename to doc/nrf/device_guides/nrf91.rst diff --git a/doc/nrf/pmic.rst b/doc/nrf/device_guides/pmic.rst similarity index 100% rename from doc/nrf/pmic.rst rename to doc/nrf/device_guides/pmic.rst diff --git a/doc/nrf/app_dev/wifi_coex/index.rst b/doc/nrf/device_guides/wifi_coex.rst similarity index 100% rename from doc/nrf/app_dev/wifi_coex/index.rst rename to doc/nrf/device_guides/wifi_coex.rst diff --git a/doc/nrf/app_dev/working_with_fem/index.rst b/doc/nrf/device_guides/working_with_fem.rst similarity index 100% rename from doc/nrf/app_dev/working_with_fem/index.rst rename to doc/nrf/device_guides/working_with_fem.rst diff --git a/doc/nrf/working_with_nrf/nrf52/developing.rst b/doc/nrf/device_guides/working_with_nrf/nrf52/developing.rst similarity index 99% rename from doc/nrf/working_with_nrf/nrf52/developing.rst rename to doc/nrf/device_guides/working_with_nrf/nrf52/developing.rst index 1c12b95da0a7..fcc2d6490205 100644 --- a/doc/nrf/working_with_nrf/nrf52/developing.rst +++ b/doc/nrf/device_guides/working_with_nrf/nrf52/developing.rst @@ -240,7 +240,7 @@ Complete the following steps to build and program using the |nRFVSC|: .. |vsc_sample_board_target_line| replace:: see the :ref:`list of supported boards ` for the build target corresponding to the nRF52 Series DK you are using -.. include:: ../../includes/vsc_build_and_run.txt +.. include:: ../../../includes/vsc_build_and_run.txt 3. Connect the nRF52 Series DK to the computer with a micro-USB cable, and then turn on the DK. diff --git a/doc/nrf/working_with_nrf/nrf52/features.rst b/doc/nrf/device_guides/working_with_nrf/nrf52/features.rst similarity index 97% rename from doc/nrf/working_with_nrf/nrf52/features.rst rename to doc/nrf/device_guides/working_with_nrf/nrf52/features.rst index 6cf81674a105..808ed36de511 100644 --- a/doc/nrf/working_with_nrf/nrf52/features.rst +++ b/doc/nrf/device_guides/working_with_nrf/nrf52/features.rst @@ -128,7 +128,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 @@ -138,7 +138,7 @@ To start developing, check out the :ref:`esb_prx_ptx` sample. Gazell ====== -.. include:: ../../protocols/gazell/index.rst +.. include:: ../../../protocols/gazell/index.rst :start-after: gz_intro_start :end-before: gz_intro_end @@ -148,7 +148,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 @@ -183,7 +183,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 @@ -193,7 +193,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 diff --git a/doc/nrf/working_with_nrf/nrf52/gs.rst b/doc/nrf/device_guides/working_with_nrf/nrf52/gs.rst similarity index 96% rename from doc/nrf/working_with_nrf/nrf52/gs.rst rename to doc/nrf/device_guides/working_with_nrf/nrf52/gs.rst index 263e609e31b4..8df6da63bbd7 100644 --- a/doc/nrf/working_with_nrf/nrf52/gs.rst +++ b/doc/nrf/device_guides/working_with_nrf/nrf52/gs.rst @@ -94,7 +94,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:: images/programmer_select_device1.png + .. figure:: ../nrf52/images/programmer_select_device1.png :alt: Programmer - Select Device Programmer - Select Device @@ -156,7 +156,7 @@ To connect using CDC-UART, complete the following steps: * Local echo: Force on * Local line editing: Force on - .. figure:: ../../getting_started/images/putty.svg + .. figure:: ../../../test_and_optimize/images/putty.svg :alt: PuTTY configuration for sending commands through UART PuTTY configuration for sending commands through UART @@ -223,7 +223,7 @@ To perform tests, complete the following steps: This example communicates over Bluetooth Low Energy using the Nordic UART Service (NUS). - .. figure:: images/nrf52_enable_cccds.png + .. figure:: ../nrf52/images/nrf52_enable_cccds.png :alt: nRF Connect for Mobile - Enable services option nRF Connect for Mobile - Enable services option @@ -234,7 +234,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:: images/nrf52_connect_log.png + .. figure:: ../nrf52/images/nrf52_connect_log.png :alt: nRF Connect for Mobile - Text shown in the log nRF Connect for Mobile - Text shown in the log @@ -254,7 +254,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:: images/nrf52_connect_client_ios.png + .. figure:: ../nrf52/images/nrf52_connect_client_ios.png :alt: nRF Connect for Mobile - Client tab nRF Connect for Mobile - Client tab @@ -267,7 +267,7 @@ To perform tests, complete the following steps: This enables messages sent to the DK to show up in nRF Connect for Mobile. - .. figure:: images/nrf52_connect_write_ios.png + .. figure:: ../nrf52/images/nrf52_connect_write_ios.png :alt: nRF Connect for Mobile - Write Value window nRF Connect for Mobile - Write Value window @@ -282,7 +282,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:: images/nrf52_connect_log_ios.png + .. figure:: ../nrf52/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 diff --git a/doc/nrf/working_with_nrf/nrf52/images/nrf52_connect_client_ios.png b/doc/nrf/device_guides/working_with_nrf/nrf52/images/nrf52_connect_client_ios.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf52/images/nrf52_connect_client_ios.png rename to doc/nrf/device_guides/working_with_nrf/nrf52/images/nrf52_connect_client_ios.png diff --git a/doc/nrf/working_with_nrf/nrf52/images/nrf52_connect_log.png b/doc/nrf/device_guides/working_with_nrf/nrf52/images/nrf52_connect_log.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf52/images/nrf52_connect_log.png rename to doc/nrf/device_guides/working_with_nrf/nrf52/images/nrf52_connect_log.png diff --git a/doc/nrf/working_with_nrf/nrf52/images/nrf52_connect_log_ios.png b/doc/nrf/device_guides/working_with_nrf/nrf52/images/nrf52_connect_log_ios.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf52/images/nrf52_connect_log_ios.png rename to doc/nrf/device_guides/working_with_nrf/nrf52/images/nrf52_connect_log_ios.png diff --git a/doc/nrf/working_with_nrf/nrf52/images/nrf52_connect_write_ios.png b/doc/nrf/device_guides/working_with_nrf/nrf52/images/nrf52_connect_write_ios.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf52/images/nrf52_connect_write_ios.png rename to doc/nrf/device_guides/working_with_nrf/nrf52/images/nrf52_connect_write_ios.png diff --git a/doc/nrf/working_with_nrf/nrf52/images/nrf52_enable_cccds.png b/doc/nrf/device_guides/working_with_nrf/nrf52/images/nrf52_enable_cccds.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf52/images/nrf52_enable_cccds.png rename to doc/nrf/device_guides/working_with_nrf/nrf52/images/nrf52_enable_cccds.png diff --git a/doc/nrf/working_with_nrf/nrf52/images/programmer_select_device1.png b/doc/nrf/device_guides/working_with_nrf/nrf52/images/programmer_select_device1.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf52/images/programmer_select_device1.png rename to doc/nrf/device_guides/working_with_nrf/nrf52/images/programmer_select_device1.png diff --git a/doc/nrf/working_with_nrf/nrf53/images/ieee802154_nrf53_multiprot_design.svg b/doc/nrf/device_guides/working_with_nrf/nrf53/images/ieee802154_nrf53_multiprot_design.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/images/ieee802154_nrf53_multiprot_design.svg rename to doc/nrf/device_guides/working_with_nrf/nrf53/images/ieee802154_nrf53_multiprot_design.svg diff --git a/doc/nrf/working_with_nrf/nrf53/images/ieee802154_nrf53_singleprot_design.svg b/doc/nrf/device_guides/working_with_nrf/nrf53/images/ieee802154_nrf53_singleprot_design.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/images/ieee802154_nrf53_singleprot_design.svg rename to doc/nrf/device_guides/working_with_nrf/nrf53/images/ieee802154_nrf53_singleprot_design.svg diff --git a/doc/nrf/working_with_nrf/nrf53/images/programmer_thingy53_mcuboot_dfu.png b/doc/nrf/device_guides/working_with_nrf/nrf53/images/programmer_thingy53_mcuboot_dfu.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/images/programmer_thingy53_mcuboot_dfu.png rename to doc/nrf/device_guides/working_with_nrf/nrf53/images/programmer_thingy53_mcuboot_dfu.png diff --git a/doc/nrf/working_with_nrf/nrf53/images/thingy53_antenna_connections.svg b/doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_antenna_connections.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/images/thingy53_antenna_connections.svg rename to doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_antenna_connections.svg diff --git a/doc/nrf/working_with_nrf/nrf53/images/thingy53_application_info.png b/doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_application_info.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/images/thingy53_application_info.png rename to doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_application_info.png diff --git a/doc/nrf/working_with_nrf/nrf53/images/thingy53_nrf5340_dk.svg b/doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_nrf5340_dk.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/images/thingy53_nrf5340_dk.svg rename to doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_nrf5340_dk.svg diff --git a/doc/nrf/working_with_nrf/nrf53/images/thingy53_progress_wheel.png b/doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_progress_wheel.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/images/thingy53_progress_wheel.png rename to doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_progress_wheel.png diff --git a/doc/nrf/working_with_nrf/nrf53/images/thingy53_sample_list.png b/doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_sample_list.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/images/thingy53_sample_list.png rename to doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_sample_list.png diff --git a/doc/nrf/working_with_nrf/nrf53/images/thingy53_sw1_sw2.svg b/doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_sw1_sw2.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/images/thingy53_sw1_sw2.svg rename to doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_sw1_sw2.svg diff --git a/doc/nrf/working_with_nrf/nrf53/images/thingy53_sw1_usb.svg b/doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_sw1_usb.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/images/thingy53_sw1_usb.svg rename to doc/nrf/device_guides/working_with_nrf/nrf53/images/thingy53_sw1_usb.svg diff --git a/doc/nrf/working_with_nrf/nrf53/nrf5340.rst b/doc/nrf/device_guides/working_with_nrf/nrf53/nrf5340.rst similarity index 99% rename from doc/nrf/working_with_nrf/nrf53/nrf5340.rst rename to doc/nrf/device_guides/working_with_nrf/nrf53/nrf5340.rst index 2127893ce804..5071c7133315 100644 --- a/doc/nrf/working_with_nrf/nrf53/nrf5340.rst +++ b/doc/nrf/device_guides/working_with_nrf/nrf53/nrf5340.rst @@ -412,7 +412,7 @@ Complete the following steps to build and program a multi-image build to the nRF .. |vsc_sample_board_target_line| replace:: select ``nrf5340dk_nrf5340_cpuapp`` or ``nrf5340dk_nrf5340_cpuapp_ns`` as the target board -.. include:: ../../includes/vsc_build_and_run.txt +.. include:: ../../../includes/vsc_build_and_run.txt 3. Program the sample or application: diff --git a/doc/nrf/working_with_nrf/nrf53/nrf5340_gs.rst b/doc/nrf/device_guides/working_with_nrf/nrf53/nrf5340_gs.rst similarity index 96% rename from doc/nrf/working_with_nrf/nrf53/nrf5340_gs.rst rename to doc/nrf/device_guides/working_with_nrf/nrf53/nrf5340_gs.rst index 2b7cc92bf4cd..63252fb51501 100644 --- a/doc/nrf/working_with_nrf/nrf53/nrf5340_gs.rst +++ b/doc/nrf/device_guides/working_with_nrf/nrf53/nrf5340_gs.rst @@ -72,7 +72,7 @@ The archive contains the HEX file used to program the sample to your DK. .. |DK| replace:: nRF5340 DK -.. include:: /working_with_nrf/nrf52/gs.rst +.. include:: ../nrf52/gs.rst :start-after: program_dk_sample_start :end-before: program_dk_sample_end @@ -84,7 +84,7 @@ If you connect to the sample now, you can go directly to Step 2 of :ref:`nrf5340 Connecting to the sample ************************ -.. include:: /working_with_nrf/nrf52/gs.rst +.. include:: ../nrf52/gs.rst :start-after: uart_dk_connect_start :end-before: uart_dk_connect_end @@ -99,7 +99,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 ` and have the connected terminal emulator open. -.. include:: /working_with_nrf/nrf52/gs.rst +.. include:: ../nrf52/gs.rst :start-after: testing_dk_start :end-before: testing_dk_end diff --git a/doc/nrf/working_with_nrf/nrf53/thingy53.rst b/doc/nrf/device_guides/working_with_nrf/nrf53/thingy53.rst similarity index 99% rename from doc/nrf/working_with_nrf/nrf53/thingy53.rst rename to doc/nrf/device_guides/working_with_nrf/nrf53/thingy53.rst index e9c0ede948cd..e4023789c715 100644 --- a/doc/nrf/working_with_nrf/nrf53/thingy53.rst +++ b/doc/nrf/device_guides/working_with_nrf/nrf53/thingy53.rst @@ -102,7 +102,7 @@ Complete the following steps to build and program using the |nRFVSC|: .. |vsc_sample_board_target_line| replace:: select ``thingy53_nrf5340_cpuapp`` as the target board -.. include:: ../../includes/vsc_build_and_run.txt +.. include:: ../../../includes/vsc_build_and_run.txt 3. Program the sample or application: diff --git a/doc/nrf/working_with_nrf/nrf53/thingy53_gs.rst b/doc/nrf/device_guides/working_with_nrf/nrf53/thingy53_gs.rst similarity index 100% rename from doc/nrf/working_with_nrf/nrf53/thingy53_gs.rst rename to doc/nrf/device_guides/working_with_nrf/nrf53/thingy53_gs.rst diff --git a/doc/nrf/working_with_nrf/nrf70/developing/constrained.rst b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/constrained.rst similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/constrained.rst rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/constrained.rst diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_change_wakeup_mode_from_dtim_to_li.png b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_change_wakeup_mode_from_dtim_to_li.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_change_wakeup_mode_from_dtim_to_li.png rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_change_wakeup_mode_from_dtim_to_li.png diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_change_wakeup_mode_from_li_to_dtim.png b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_change_wakeup_mode_from_li_to_dtim.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_change_wakeup_mode_from_li_to_dtim.png rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_change_wakeup_mode_from_li_to_dtim.png diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_group_frames.svg b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_group_frames.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_group_frames.svg rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_group_frames.svg diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_legacy_power_save.svg b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_legacy_power_save.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_legacy_power_save.svg rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_legacy_power_save.svg diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_twt.svg b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_twt.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_twt.svg rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_twt.svg diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_twt_wake_interval.svg b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_twt_wake_interval.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_twt_wake_interval.svg rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_twt_wake_interval.svg diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_wmm_power_save.svg b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_wmm_power_save.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/nRF70_ug_wmm_power_save.svg rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/nRF70_ug_wmm_power_save.svg diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/power_profiler2_pc_nrf7002_dk.svg b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/power_profiler2_pc_nrf7002_dk.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/power_profiler2_pc_nrf7002_dk.svg rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/power_profiler2_pc_nrf7002_dk.svg diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/power_profiler_dtim_output.png b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/power_profiler_dtim_output.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/power_profiler_dtim_output.png rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/power_profiler_dtim_output.png diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/power_profiler_dtim_wakeup.png b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/power_profiler_dtim_wakeup.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/power_profiler_dtim_wakeup.png rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/power_profiler_dtim_wakeup.png diff --git a/doc/nrf/working_with_nrf/nrf70/developing/images/power_profiler_twt.png b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/power_profiler_twt.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/images/power_profiler_twt.png rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/images/power_profiler_twt.png diff --git a/doc/nrf/working_with_nrf/nrf70/developing/index.rst b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/index.rst similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/index.rst rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/index.rst diff --git a/doc/nrf/working_with_nrf/nrf70/developing/powersave.rst b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/powersave.rst similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/powersave.rst rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/powersave.rst diff --git a/doc/nrf/working_with_nrf/nrf70/developing/regulatory_support.rst b/doc/nrf/device_guides/working_with_nrf/nrf70/developing/regulatory_support.rst similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/developing/regulatory_support.rst rename to doc/nrf/device_guides/working_with_nrf/nrf70/developing/regulatory_support.rst diff --git a/doc/nrf/working_with_nrf/nrf70/features.rst b/doc/nrf/device_guides/working_with_nrf/nrf70/features.rst similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/features.rst rename to doc/nrf/device_guides/working_with_nrf/nrf70/features.rst diff --git a/doc/nrf/working_with_nrf/nrf70/gs.rst b/doc/nrf/device_guides/working_with_nrf/nrf70/gs.rst similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/gs.rst rename to doc/nrf/device_guides/working_with_nrf/nrf70/gs.rst diff --git a/doc/nrf/working_with_nrf/nrf70/images/nRF70dk.png b/doc/nrf/device_guides/working_with_nrf/nrf70/images/nRF70dk.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/images/nRF70dk.png rename to doc/nrf/device_guides/working_with_nrf/nrf70/images/nRF70dk.png diff --git a/doc/nrf/working_with_nrf/nrf70/images/nrf70_ug_overview.svg b/doc/nrf/device_guides/working_with_nrf/nrf70/images/nrf70_ug_overview.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf70/images/nrf70_ug_overview.svg rename to doc/nrf/device_guides/working_with_nrf/nrf70/images/nrf70_ug_overview.svg diff --git a/doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_automaticrequests.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_automaticrequests.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_automaticrequests.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_automaticrequests.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_loadjson.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_loadjson.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_loadjson.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_loadjson.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_navigationcertificatemanager.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_navigationcertificatemanager.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_navigationcertificatemanager.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_navigationcertificatemanager.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_navigationterminal.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_navigationterminal.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_navigationterminal.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_navigationterminal.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_selectdevice.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_selectdevice.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_selectdevice.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_selectdevice.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_updatecertificates.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_updatecertificates.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/ltelinkmonitor_updatecertificates.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/ltelinkmonitor_updatecertificates.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/nrf9160_ug_overview.svg b/doc/nrf/device_guides/working_with_nrf/nrf91/images/nrf9160_ug_overview.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/nrf9160_ug_overview.svg rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/nrf9160_ug_overview.svg diff --git a/doc/nrf/working_with_nrf/nrf91/images/nrfcloud_activating_sim.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_activating_sim.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/nrfcloud_activating_sim.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_activating_sim.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/nrfcloud_add_lte_device.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_add_lte_device.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/nrfcloud_add_lte_device.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_add_lte_device.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/nrfcloud_add_lte_device1.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_add_lte_device1.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/nrfcloud_add_lte_device1.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_add_lte_device1.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/nrfcloud_devices.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_devices.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/nrfcloud_devices.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_devices.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/nrfcloud_jitpcertificates.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_jitpcertificates.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/nrfcloud_jitpcertificates.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_jitpcertificates.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/nrfcloud_plus_sign_callout.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_plus_sign_callout.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/nrfcloud_plus_sign_callout.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_plus_sign_callout.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/nrfcloud_provisiondevices.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_provisiondevices.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/nrfcloud_provisiondevices.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_provisiondevices.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/nrfcloud_provisiondevices_gearicon.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_provisiondevices_gearicon.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/nrfcloud_provisiondevices_gearicon.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/nrfcloud_provisiondevices_gearicon.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/power_consumption.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/power_consumption.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/power_consumption.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/power_consumption.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_add_file.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_add_file.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_add_file.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_add_file.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_add_file1.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_add_file1.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_add_file1.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_add_file1.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_add_file2.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_add_file2.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_add_file2.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_add_file2.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_addfile_nrf9160dk.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_addfile_nrf9160dk.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_addfile_nrf9160dk.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_addfile_nrf9160dk.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_com_ports.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_com_ports.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_com_ports.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_com_ports.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_enable_mcuboot.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_enable_mcuboot.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_enable_mcuboot.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_enable_mcuboot.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_erasewrite_nrf9160dk.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_erasewrite_nrf9160dk.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_erasewrite_nrf9160dk.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_erasewrite_nrf9160dk.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_ext_debug_hex_write.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_ext_debug_hex_write.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_ext_debug_hex_write.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_ext_debug_hex_write.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_ext_debug_update_modem.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_ext_debug_update_modem.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_ext_debug_update_modem.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_ext_debug_update_modem.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_hex_write.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_hex_write.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_hex_write.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_hex_write.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_hex_write1.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_hex_write1.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_hex_write1.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_hex_write1.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_modemdfu.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_modemdfu.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_modemdfu.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_modemdfu.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_select_device.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_select_device.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_select_device.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_select_device.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_select_device2.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_select_device2.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_select_device2.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_select_device2.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_thingy91_connect_dk_swd_vddio.svg b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_thingy91_connect_dk_swd_vddio.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_thingy91_connect_dk_swd_vddio.svg rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_thingy91_connect_dk_swd_vddio.svg diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_usb_update_modem.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_usb_update_modem.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_usb_update_modem.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_usb_update_modem.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmer_write_nrf9160dk.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_write_nrf9160dk.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmer_write_nrf9160dk.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmer_write_nrf9160dk.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/programmerapp_modemdfu.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/programmerapp_modemdfu.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/programmerapp_modemdfu.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/programmerapp_modemdfu.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/thingy91_insert_sim.svg b/doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_insert_sim.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/thingy91_insert_sim.svg rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_insert_sim.svg diff --git a/doc/nrf/working_with_nrf/nrf91/images/thingy91_mcuboot_dfu.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_mcuboot_dfu.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/thingy91_mcuboot_dfu.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_mcuboot_dfu.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/thingy91_mcuboot_dfu1.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_mcuboot_dfu1.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/thingy91_mcuboot_dfu1.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_mcuboot_dfu1.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/thingy91_modemdfu_mcuboot.png b/doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_modemdfu_mcuboot.png similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/thingy91_modemdfu_mcuboot.png rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_modemdfu_mcuboot.png diff --git a/doc/nrf/working_with_nrf/nrf91/images/thingy91_pin_imei.svg b/doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_pin_imei.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/thingy91_pin_imei.svg rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_pin_imei.svg diff --git a/doc/nrf/working_with_nrf/nrf91/images/thingy91_pwr_switch.svg b/doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_pwr_switch.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/thingy91_pwr_switch.svg rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_pwr_switch.svg diff --git a/doc/nrf/working_with_nrf/nrf91/images/thingy91_sw1_sw3.svg b/doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_sw1_sw3.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/thingy91_sw1_sw3.svg rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_sw1_sw3.svg diff --git a/doc/nrf/working_with_nrf/nrf91/images/thingy91_sw1_sw4.svg b/doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_sw1_sw4.svg similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/images/thingy91_sw1_sw4.svg rename to doc/nrf/device_guides/working_with_nrf/nrf91/images/thingy91_sw1_sw4.svg diff --git a/doc/nrf/working_with_nrf/nrf91/nrf9160.rst b/doc/nrf/device_guides/working_with_nrf/nrf91/nrf9160.rst similarity index 99% rename from doc/nrf/working_with_nrf/nrf91/nrf9160.rst rename to doc/nrf/device_guides/working_with_nrf/nrf91/nrf9160.rst index 5582be6db30d..3e26ee0a233f 100644 --- a/doc/nrf/working_with_nrf/nrf91/nrf9160.rst +++ b/doc/nrf/device_guides/working_with_nrf/nrf91/nrf9160.rst @@ -210,7 +210,7 @@ Complete the following steps to build and program using the |nRFVSC|: .. |vsc_sample_board_target_line| replace:: you must use the build target ``nrf9160dk_nrf9160_ns`` when building the application code for the nRF9160 DK -.. include:: ../../includes/vsc_build_and_run.txt +.. include:: ../../../includes/vsc_build_and_run.txt 3. Program the application: @@ -241,7 +241,7 @@ Building and programming on the command line .. |cmd_build_target| replace:: ``nrf9160dk_nrf9160_ns`` when building the application code for the nRF9160 DK -.. include:: ../../includes/cmd_build_and_run.txt +.. include:: ../../../includes/cmd_build_and_run.txt #. Program the application: diff --git a/doc/nrf/working_with_nrf/nrf91/nrf9160_gs.rst b/doc/nrf/device_guides/working_with_nrf/nrf91/nrf9160_gs.rst similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/nrf9160_gs.rst rename to doc/nrf/device_guides/working_with_nrf/nrf91/nrf9160_gs.rst diff --git a/doc/nrf/working_with_nrf/nrf91/nrf91_features.rst b/doc/nrf/device_guides/working_with_nrf/nrf91/nrf91_features.rst similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/nrf91_features.rst rename to doc/nrf/device_guides/working_with_nrf/nrf91/nrf91_features.rst diff --git a/doc/nrf/working_with_nrf/nrf91/thingy91.rst b/doc/nrf/device_guides/working_with_nrf/nrf91/thingy91.rst similarity index 99% rename from doc/nrf/working_with_nrf/nrf91/thingy91.rst rename to doc/nrf/device_guides/working_with_nrf/nrf91/thingy91.rst index 46e307b0b3ea..990c413e3c05 100644 --- a/doc/nrf/working_with_nrf/nrf91/thingy91.rst +++ b/doc/nrf/device_guides/working_with_nrf/nrf91/thingy91.rst @@ -176,7 +176,7 @@ Complete the following steps to build and program using the |nRFVSC|: .. |vsc_sample_board_target_line| replace:: you must use the build target ``thingy91_nrf9160_ns`` when building the application code for the nRF9160 SiP and the build target ``thingy91_nrf52840`` when building the application code for the onboard nRF52840 SoC -.. include:: ../../includes/vsc_build_and_run.txt +.. include:: ../../../includes/vsc_build_and_run.txt 3. Program the application: @@ -211,7 +211,7 @@ Building and programming on the command line .. |cmd_build_target| replace:: ``thingy91_nrf9160_ns`` if building for the nRF9160 SiP component and ``thingy91_nrf52840`` if building for the nRF52840 SoC component -.. include:: ../../includes/cmd_build_and_run.txt +.. include:: ../../../includes/cmd_build_and_run.txt #. Program the application: diff --git a/doc/nrf/working_with_nrf/nrf91/thingy91_gsg.rst b/doc/nrf/device_guides/working_with_nrf/nrf91/thingy91_gsg.rst similarity index 100% rename from doc/nrf/working_with_nrf/nrf91/thingy91_gsg.rst rename to doc/nrf/device_guides/working_with_nrf/nrf91/thingy91_gsg.rst diff --git a/doc/nrf/working_with_pmic/npm1300/features.rst b/doc/nrf/device_guides/working_with_pmic/npm1300/features.rst similarity index 100% rename from doc/nrf/working_with_pmic/npm1300/features.rst rename to doc/nrf/device_guides/working_with_pmic/npm1300/features.rst diff --git a/doc/nrf/working_with_pmic/npm1300/gs.rst b/doc/nrf/device_guides/working_with_pmic/npm1300/gs.rst similarity index 100% rename from doc/nrf/working_with_pmic/npm1300/gs.rst rename to doc/nrf/device_guides/working_with_pmic/npm1300/gs.rst diff --git a/doc/nrf/documentation.rst b/doc/nrf/documentation.rst index 7a06c36d9f85..0894552ca90a 100644 --- a/doc/nrf/documentation.rst +++ b/doc/nrf/documentation.rst @@ -13,8 +13,9 @@ The documentation follows specific conventions and templates proper to the |NCS| :maxdepth: 2 :caption: Subpages: + documentation/glossary documentation/structure + documentation/build_process documentation/build documentation/styleguide documentation/templates - documentation/build_process diff --git a/doc/nrf/glossary.rst b/doc/nrf/documentation/glossary.rst similarity index 100% rename from doc/nrf/glossary.rst rename to doc/nrf/documentation/glossary.rst diff --git a/doc/nrf/index.rst b/doc/nrf/index.rst index d46df07444d0..bd47419a3f68 100644 --- a/doc/nrf/index.rst +++ b/doc/nrf/index.rst @@ -14,28 +14,22 @@ A "99" at the end of the version number of this documentation indicates continuo .. toctree:: :maxdepth: 2 :caption: Contents + :hidden: introduction - getting_started - dev_model - app_dev + installation + config_and_build + test_and_optimize + device_guides security - integrations - nrf91 - nrf70 - nrf53 - nrf52 - pmic protocols applications samples drivers libraries/index scripts - release_notes - known_issues - software_maturity + integrations + releases_and_maturity documentation - glossary .. templates/cheat_sheet diff --git a/doc/nrf/getting_started.rst b/doc/nrf/installation.rst similarity index 75% rename from doc/nrf/getting_started.rst rename to doc/nrf/installation.rst index 23f6bf17ff27..3896e029b5ca 100644 --- a/doc/nrf/getting_started.rst +++ b/doc/nrf/installation.rst @@ -1,7 +1,7 @@ .. _getting_started: -Getting started -############### +Installation +############ To start working with the |NCS|, :ref:`set up your development environment automatically using nRF Connect for Desktop `. This will install all the :ref:`requirements `, including the |VSC| and the `nRF Connect for Visual Studio Code`_ extension, which is recommended for building applications. @@ -15,10 +15,7 @@ If you have any issues when installing the |NCS| automatically, :ref:`install th :maxdepth: 2 :caption: Subpages: - getting_started/recommended_versions - getting_started/assistant - getting_started/installing - getting_started/programming - getting_started/testing - getting_started/modifying - getting_started/updating + installation/recommended_versions + installation/assistant + installation/installing + installation/updating diff --git a/doc/nrf/getting_started/assistant.rst b/doc/nrf/installation/assistant.rst similarity index 100% rename from doc/nrf/getting_started/assistant.rst rename to doc/nrf/installation/assistant.rst diff --git a/doc/nrf/getting_started/images/gs-assistant_tm.png b/doc/nrf/installation/images/gs-assistant_tm.png similarity index 100% rename from doc/nrf/getting_started/images/gs-assistant_tm.png rename to doc/nrf/installation/images/gs-assistant_tm.png diff --git a/doc/nrf/getting_started/images/gs-assistant_tm_dropdown.png b/doc/nrf/installation/images/gs-assistant_tm_dropdown.png similarity index 100% rename from doc/nrf/getting_started/images/gs-assistant_tm_dropdown.png rename to doc/nrf/installation/images/gs-assistant_tm_dropdown.png diff --git a/doc/nrf/getting_started/installing.rst b/doc/nrf/installation/installing.rst similarity index 100% rename from doc/nrf/getting_started/installing.rst rename to doc/nrf/installation/installing.rst diff --git a/doc/nrf/getting_started/recommended_versions.rst b/doc/nrf/installation/recommended_versions.rst similarity index 100% rename from doc/nrf/getting_started/recommended_versions.rst rename to doc/nrf/installation/recommended_versions.rst diff --git a/doc/nrf/getting_started/updating.rst b/doc/nrf/installation/updating.rst similarity index 100% rename from doc/nrf/getting_started/updating.rst rename to doc/nrf/installation/updating.rst diff --git a/doc/nrf/protocols/matter/end_product/security.rst b/doc/nrf/protocols/matter/end_product/security.rst index 920d08100a8a..454f2abb7ca1 100644 --- a/doc/nrf/protocols/matter/end_product/security.rst +++ b/doc/nrf/protocols/matter/end_product/security.rst @@ -14,7 +14,7 @@ Enable AP-Protect Make sure to enable the AP-Protect feature for the production devices to disable the debug functionality. -.. include:: ../../../app_dev/ap_protect/index.rst +.. include:: ../../../security/ap_protect.rst :start-after: app_approtect_info_start :end-before: app_approtect_info_end diff --git a/doc/nrf/releases_and_maturity.rst b/doc/nrf/releases_and_maturity.rst new file mode 100644 index 000000000000..fe185a9cadd3 --- /dev/null +++ b/doc/nrf/releases_and_maturity.rst @@ -0,0 +1,18 @@ +.. _releases_and_maturity: + +Releases and maturity +##################### + +The |NCS| receives regular releases, which introduce new components or fix issues in existing features, according to the criteria for :ref:`versions and revisions `. +Each new release comes with its own :ref:`release_notes` and can also change the :ref:`software_maturity` of the existing components. + +If an issue is found in a release after it has taken place, those issues are listed on the :ref:`known_issues` page. + +.. toctree:: + :maxdepth: 2 + :caption: Subpages: + + releases_and_maturity/dev_model + releases_and_maturity/release_notes + releases_and_maturity/software_maturity + releases_and_maturity/known_issues diff --git a/doc/nrf/dev_model.rst b/doc/nrf/releases_and_maturity/dev_model.rst similarity index 100% rename from doc/nrf/dev_model.rst rename to doc/nrf/releases_and_maturity/dev_model.rst diff --git a/doc/nrf/developing/adding_code.rst b/doc/nrf/releases_and_maturity/developing/adding_code.rst similarity index 100% rename from doc/nrf/developing/adding_code.rst rename to doc/nrf/releases_and_maturity/developing/adding_code.rst diff --git a/doc/nrf/developing/code_base.rst b/doc/nrf/releases_and_maturity/developing/code_base.rst similarity index 100% rename from doc/nrf/developing/code_base.rst rename to doc/nrf/releases_and_maturity/developing/code_base.rst diff --git a/doc/nrf/developing/images/ncs-west-repos.svg b/doc/nrf/releases_and_maturity/developing/images/ncs-west-repos.svg similarity index 100% rename from doc/nrf/developing/images/ncs-west-repos.svg rename to doc/nrf/releases_and_maturity/developing/images/ncs-west-repos.svg diff --git a/doc/nrf/developing/managing_code.rst b/doc/nrf/releases_and_maturity/developing/managing_code.rst similarity index 100% rename from doc/nrf/developing/managing_code.rst rename to doc/nrf/releases_and_maturity/developing/managing_code.rst diff --git a/doc/nrf/developing/ncs_distro.rst b/doc/nrf/releases_and_maturity/developing/ncs_distro.rst similarity index 100% rename from doc/nrf/developing/ncs_distro.rst rename to doc/nrf/releases_and_maturity/developing/ncs_distro.rst diff --git a/doc/nrf/known_issues.rst b/doc/nrf/releases_and_maturity/known_issues.rst similarity index 99% rename from doc/nrf/known_issues.rst rename to doc/nrf/releases_and_maturity/known_issues.rst index a9d42bfda7f1..001d83423822 100644 --- a/doc/nrf/known_issues.rst +++ b/doc/nrf/releases_and_maturity/known_issues.rst @@ -22,7 +22,7 @@ A known issue can list one or both of the following entries: Sometimes, they are discovered later and added over time. .. raw:: html - :file: includes/filter.js + :file: ../includes/filter.js .. raw:: html diff --git a/doc/nrf/migration/migration_guide_1.x_to_2.x.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.rst similarity index 100% rename from doc/nrf/migration/migration_guide_1.x_to_2.x.rst rename to doc/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.rst diff --git a/doc/nrf/release_notes.rst b/doc/nrf/releases_and_maturity/release_notes.rst similarity index 100% rename from doc/nrf/release_notes.rst rename to doc/nrf/releases_and_maturity/release_notes.rst diff --git a/doc/nrf/releases/release-notes-0.1.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-0.1.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-0.1.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-0.1.0.rst diff --git a/doc/nrf/releases/release-notes-0.3.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-0.3.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-0.3.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-0.3.0.rst diff --git a/doc/nrf/releases/release-notes-0.4.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-0.4.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-0.4.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-0.4.0.rst diff --git a/doc/nrf/releases/release-notes-1.0.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.0.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.0.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.0.0.rst diff --git a/doc/nrf/releases/release-notes-1.1.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.1.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.1.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.1.0.rst diff --git a/doc/nrf/releases/release-notes-1.2.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.2.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.2.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.2.0.rst diff --git a/doc/nrf/releases/release-notes-1.2.1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.2.1.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.2.1.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.2.1.rst diff --git a/doc/nrf/releases/release-notes-1.3.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.3.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.3.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.3.0.rst diff --git a/doc/nrf/releases/release-notes-1.3.1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.3.1.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.3.1.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.3.1.rst diff --git a/doc/nrf/releases/release-notes-1.3.2.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.3.2.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.3.2.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.3.2.rst diff --git a/doc/nrf/releases/release-notes-1.4.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.4.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.4.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.4.0.rst diff --git a/doc/nrf/releases/release-notes-1.4.1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.4.1.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.4.1.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.4.1.rst diff --git a/doc/nrf/releases/release-notes-1.4.2.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.4.2.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.4.2.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.4.2.rst diff --git a/doc/nrf/releases/release-notes-1.5.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.5.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.5.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.5.0.rst diff --git a/doc/nrf/releases/release-notes-1.5.1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.5.1.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.5.1.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.5.1.rst diff --git a/doc/nrf/releases/release-notes-1.5.2.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.5.2.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.5.2.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.5.2.rst diff --git a/doc/nrf/releases/release-notes-1.6.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.6.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.6.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.6.0.rst diff --git a/doc/nrf/releases/release-notes-1.6.1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.6.1.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.6.1.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.6.1.rst diff --git a/doc/nrf/releases/release-notes-1.7.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.7.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.7.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.7.0.rst diff --git a/doc/nrf/releases/release-notes-1.7.1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.7.1.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.7.1.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.7.1.rst diff --git a/doc/nrf/releases/release-notes-1.8.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.8.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.8.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.8.0.rst diff --git a/doc/nrf/releases/release-notes-1.9.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.9.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.9.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.9.0.rst diff --git a/doc/nrf/releases/release-notes-1.9.1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.9.1.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.9.1.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.9.1.rst diff --git a/doc/nrf/releases/release-notes-1.9.2.rst b/doc/nrf/releases_and_maturity/releases/release-notes-1.9.2.rst similarity index 100% rename from doc/nrf/releases/release-notes-1.9.2.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-1.9.2.rst diff --git a/doc/nrf/releases/release-notes-2.0.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.0.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.0.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.0.0.rst diff --git a/doc/nrf/releases/release-notes-2.0.1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.0.1.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.0.1.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.0.1.rst diff --git a/doc/nrf/releases/release-notes-2.0.2.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.0.2.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.0.2.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.0.2.rst diff --git a/doc/nrf/releases/release-notes-2.1.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.1.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.1.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.1.0.rst diff --git a/doc/nrf/releases/release-notes-2.1.1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.1.1.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.1.1.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.1.1.rst diff --git a/doc/nrf/releases/release-notes-2.1.2.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.1.2.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.1.2.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.1.2.rst diff --git a/doc/nrf/releases/release-notes-2.1.3.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.1.3.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.1.3.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.1.3.rst diff --git a/doc/nrf/releases/release-notes-2.1.4.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.1.4.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.1.4.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.1.4.rst diff --git a/doc/nrf/releases/release-notes-2.2.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.2.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.2.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.2.0.rst diff --git a/doc/nrf/releases/release-notes-2.3.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.3.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.3.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.3.0.rst diff --git a/doc/nrf/releases/release-notes-2.4.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.4.0.rst similarity index 100% rename from doc/nrf/releases/release-notes-2.4.0.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.4.0.rst diff --git a/doc/nrf/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst similarity index 92% rename from doc/nrf/releases/release-notes-changelog.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst index ccf695192f2c..ecb863581e73 100644 --- a/doc/nrf/releases/release-notes-changelog.rst +++ b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst @@ -538,12 +538,19 @@ cJSON Documentation ============= -Added: +* Added: + + * A page on :ref:`ug_wireless_coexistence` in :ref:`protocols`. + * Pages on :ref:`thread_device_types` and :ref:`thread_sed_ssed` to the :ref:`ug_thread` documentation. + * A new section :ref:`ug_pmic`, containing :ref:`ug_npm1300_features` and :ref:`ug_npm1300_gs`. -* A page on :ref:`ug_wireless_coexistence` in :ref:`protocols`. -* Pages on :ref:`thread_device_types` and :ref:`thread_sed_ssed` to the :ref:`ug_thread` documentation. -* A new section :ref:`ug_pmic`, containing :ref:`ug_npm1300_features` and :ref:`ug_npm1300_gs`. +* Updated: -Updated: + * The :ref:`emds_readme` library documentation with :ref:`emds_readme_application_integration` section about the formula used to compute the required storage time at shutdown in a worst case scenario. + * The structure of the |NCS| documentation at its top level, with the following major changes: -* The :ref:`emds_readme` library documentation with :ref:`emds_readme_application_integration` section about the formula used to compute the required storage time at shutdown in a worst case scenario. + * The getting started section has been replaced with :ref:`Installation `. + * The guides previously located in the application development section have been moved to :ref:`config_and_build`, :ref:`test_and_optimize`, :ref:`device_guides`, and :ref:`security_index`. + Some of these new sections also include guides that were previously in the getting started section. + * "Working with..." device guides are now located under :ref:`device_guides`. + * :ref:`release_notes`, :ref:`software_maturity`, :ref:`known_issues`, :ref:`glossary`, and :ref:`dev-model` are now located under :ref:`releases_and_maturity`. diff --git a/doc/nrf/software_maturity.rst b/doc/nrf/releases_and_maturity/software_maturity.rst similarity index 100% rename from doc/nrf/software_maturity.rst rename to doc/nrf/releases_and_maturity/software_maturity.rst diff --git a/doc/nrf/security.rst b/doc/nrf/security.rst index dc0bbfa75a16..da2e68530472 100644 --- a/doc/nrf/security.rst +++ b/doc/nrf/security.rst @@ -1,79 +1,20 @@ -.. _security: +.. _security_index: Security ######## -.. contents:: - :local: - :depth: 2 +The |NCS| provides a variety of security features. +Make sure to check the :ref:`overview of available options ` and consider enabling :ref:`access port protection mechanism `. -The following sections give a brief introduction to core security features available in Nordic Semiconductor products. -The features are made available either as built-ins in modules, drivers, and subsystems, or are shown in samples or applications in |NCS|. +If you are working with nRF53 Series or nRF91 Series devices, use :ref:`Trusted Firmware-M ` to increase the security of your end product. -Secure boot -*********** +.. toctree:: + :maxdepth: 2 + :caption: Subpages: -The |NCS| supports secure boot of application images enforced by the bootloader. -The secure boot utilizes signature validation and security hardware features to establish a root-of-trust during the boot process, and to ensure the validity of the firmware that is booted. + security/security + security/tfm + security/ap_protect -There are two available bootloaders in |NCS|: -* :ref:`nRF Secure Immutable Bootloader (NSIB) `, enabled by the configuration option :kconfig:option:`CONFIG_SECURE_BOOT`. -* A customized version of `sdk-mcuboot`_, enabled by the configuration option :kconfig:option:`CONFIG_BOOTLOADER_MCUBOOT`. -When enabling the NSIB, the MCUboot can serve as an upgradable second-stage bootloader. -For more information about the bootloaders, see :ref:`app_bootloaders`. - -Trusted Firmware-M -****************** - -The Trusted Firmware-M project (TF-M) is a reference design of the Arm `Platform Security Architecture (PSA)`_. -Through TF-M, |NCS| utilizes the security features of the Arm TrustZone technology to configure secure peripherals and memory, and to provide PSA functional APIs as secure services. - -TF-M enables hardware supported separation of a Secure Processing Environment (SPE) and a Non-Secure Processing Environment (NSPE) that constitutes the Zephyr RTOS, protocol stacks, and the application. -Enable TF-M in a project by enabling the :kconfig:option:`CONFIG_BUILD_WITH_TFM` option. - -For more information about the TF-M, see the `TF-M documentation`_ and :ref:`ug_tfm`. -For more information about SPE and NSPE in the |NCS|, see :ref:`app_boards_spe_nspe`. - -Hardware unique key -******************* - -Nordic Semiconductor devices featuring the CryptoCell cryptographic accelerator allow the usage of a hardware unique key (HUK) for key derivation. -A HUK is a unique symmetric cryptographic key which is loaded in special hardware registers allowing the application to use the key by reference, without any access to the key material. -To enable the HUK in an application, enable the :kconfig:option:`CONFIG_HW_UNIQUE_KEY` option. - -For more information, see the hardware unique key :ref:`library ` and :ref:`sample `. - -Device firmware upgrade (DFU) -***************************** - -The |NCS| supports firmware upgrade using over-the-air (OTA) and serial firmware upgrades, depending on the capabilities of the device. -For more information about the firmware upgrades, see the available :ref:`DFU libraries `. - -The |NCS| can be configured to enforce secure DFU mechanisms, including validating the digital signature of an image and checking for the version to prevent downgrade attacks. -The secure DFU mechanisms are handled by the MCUboot bootloader. -For more information, see the :doc:`MCUboot documentation `. - -Cryptographic operations in |NCS| -********************************* - -Cryptographic operations in |NCS| are handled by the :ref:`nrf_security`, which is configurable through Kconfig options. -The module can be enabled through the :kconfig:option:`CONFIG_NRF_SECURITY` Kconfig option, and it allows the usage of `Mbed TLS`_ and `PSA Cryptography API 1.0.1`_ for cryptographic operations and random number generation in the application. - -The :ref:`nrf_security` acts as an orchestrator for the different cryptographic libraries available in the system. -These libraries include the binary versions of accelerated cryptographic libraries listed in :ref:`nrfxlib:crypto`, and the open source Mbed TLS implementation in |NCS| located in `sdk-mbedtls`_. - -The Kconfig option :kconfig:option:`CONFIG_NRF_SECURITY` prioritizes the usage of the accelerated libraries by default when this is supported by the platform. -For more information about the configuration and usage of the :ref:`nrf_security`, see the :ref:`nrf_security_config` page. - -See also :ref:`crypto_samples` for examples of how to configure and perform different cryptographic operations in the |NCS|. - -Access port protection mechanism -******************************** - -.. include:: app_dev/ap_protect/index.rst - :start-after: app_approtect_info_start - :end-before: app_approtect_info_end - -For more information, see :ref:`app_approtect`. diff --git a/doc/nrf/app_dev/ap_protect/index.rst b/doc/nrf/security/ap_protect.rst similarity index 100% rename from doc/nrf/app_dev/ap_protect/index.rst rename to doc/nrf/security/ap_protect.rst diff --git a/doc/nrf/security/security.rst b/doc/nrf/security/security.rst new file mode 100644 index 000000000000..ad88498a5258 --- /dev/null +++ b/doc/nrf/security/security.rst @@ -0,0 +1,79 @@ +.. _security: + +Security +######## + +.. contents:: + :local: + :depth: 2 + +The following sections give a brief introduction to core security features available in Nordic Semiconductor products. +The features are made available either as built-ins in modules, drivers, and subsystems, or are shown in samples or applications in |NCS|. + +Secure boot +*********** + +The |NCS| supports secure boot of application images enforced by the bootloader. +The secure boot utilizes signature validation and security hardware features to establish a root-of-trust during the boot process, and to ensure the validity of the firmware that is booted. + +There are two available bootloaders in |NCS|: + +* :ref:`nRF Secure Immutable Bootloader (NSIB) `, enabled by the configuration option :kconfig:option:`CONFIG_SECURE_BOOT`. +* A customized version of `sdk-mcuboot`_, enabled by the configuration option :kconfig:option:`CONFIG_BOOTLOADER_MCUBOOT`. + +When enabling the NSIB, the MCUboot can serve as an upgradable second-stage bootloader. +For more information about the bootloaders, see :ref:`app_bootloaders`. + +Trusted Firmware-M +****************** + +The Trusted Firmware-M project (TF-M) is a reference design of the Arm `Platform Security Architecture (PSA)`_. +Through TF-M, |NCS| utilizes the security features of the Arm TrustZone technology to configure secure peripherals and memory, and to provide PSA functional APIs as secure services. + +TF-M enables hardware supported separation of a Secure Processing Environment (SPE) and a Non-Secure Processing Environment (NSPE) that constitutes the Zephyr RTOS, protocol stacks, and the application. +Enable TF-M in a project by enabling the :kconfig:option:`CONFIG_BUILD_WITH_TFM` option. + +For more information about the TF-M, see the `TF-M documentation`_ and :ref:`ug_tfm`. +For more information about SPE and NSPE in the |NCS|, see :ref:`app_boards_spe_nspe`. + +Hardware unique key +******************* + +Nordic Semiconductor devices featuring the CryptoCell cryptographic accelerator allow the usage of a hardware unique key (HUK) for key derivation. +A HUK is a unique symmetric cryptographic key which is loaded in special hardware registers allowing the application to use the key by reference, without any access to the key material. +To enable the HUK in an application, enable the :kconfig:option:`CONFIG_HW_UNIQUE_KEY` option. + +For more information, see the hardware unique key :ref:`library ` and :ref:`sample `. + +Device firmware upgrade (DFU) +***************************** + +The |NCS| supports firmware upgrade using over-the-air (OTA) and serial firmware upgrades, depending on the capabilities of the device. +For more information about the firmware upgrades, see the available :ref:`DFU libraries `. + +The |NCS| can be configured to enforce secure DFU mechanisms, including validating the digital signature of an image and checking for the version to prevent downgrade attacks. +The secure DFU mechanisms are handled by the MCUboot bootloader. +For more information, see the :doc:`MCUboot documentation `. + +Cryptographic operations in |NCS| +********************************* + +Cryptographic operations in |NCS| are handled by the :ref:`nrf_security`, which is configurable through Kconfig options. +The module can be enabled through the :kconfig:option:`CONFIG_NRF_SECURITY` Kconfig option, and it allows the usage of `Mbed TLS`_ and `PSA Cryptography API 1.0.1`_ for cryptographic operations and random number generation in the application. + +The :ref:`nrf_security` acts as an orchestrator for the different cryptographic libraries available in the system. +These libraries include the binary versions of accelerated cryptographic libraries listed in :ref:`nrfxlib:crypto`, and the open source Mbed TLS implementation in |NCS| located in `sdk-mbedtls`_. + +The Kconfig option :kconfig:option:`CONFIG_NRF_SECURITY` prioritizes the usage of the accelerated libraries by default when this is supported by the platform. +For more information about the configuration and usage of the :ref:`nrf_security`, see the :ref:`nrf_security_config` page. + +See also :ref:`crypto_samples` for examples of how to configure and perform different cryptographic operations in the |NCS|. + +Access port protection mechanism +******************************** + +.. include:: ap_protect.rst + :start-after: app_approtect_info_start + :end-before: app_approtect_info_end + +For more information, see :ref:`app_approtect`. diff --git a/doc/nrf/app_dev/tfm/index.rst b/doc/nrf/security/tfm.rst similarity index 100% rename from doc/nrf/app_dev/tfm/index.rst rename to doc/nrf/security/tfm.rst diff --git a/doc/nrf/templates/cheat_sheet.rst b/doc/nrf/templates/cheat_sheet.rst index 0a6d08ea3bad..19fc7e1f5385 100644 --- a/doc/nrf/templates/cheat_sheet.rst +++ b/doc/nrf/templates/cheat_sheet.rst @@ -332,7 +332,7 @@ Include 1: :end-line: 27 Include 2: - .. include:: ../getting_started/installing.rst + .. include:: ../installation/installing.rst :start-after: west-error-start :end-before: west-error-end @@ -355,7 +355,7 @@ Include 4: You can also use ncs-include if you want to use the indentation options inside the nrf doc set: Include 5 (similar to include 2, but improved indentation): - .. ncs-include:: ../getting_started/installing.rst + .. ncs-include:: ../installation/installing.rst :start-after: west-error-start :end-before: west-error-end :auto-dedent: diff --git a/doc/nrf/test_and_optimize.rst b/doc/nrf/test_and_optimize.rst new file mode 100644 index 000000000000..c72abd7b3855 --- /dev/null +++ b/doc/nrf/test_and_optimize.rst @@ -0,0 +1,17 @@ +.. _test_and_optimize: + +Testing and optimization +######################## + +Each :ref:`applications` and :ref:`samples` in the |NCS| come with their own testing instructions. +However, the |NCS| provides a common set of features and options for debugging and optimizing the application performance. +This includes a multilevel logging system that can be enabled and configured independently for different modules, and support for writing unit tests using Unity and CMock. + +.. toctree:: + :maxdepth: 2 + :caption: Subpages: + + test_and_optimize/testing + test_and_optimize/logging + test_and_optimize/testing_unity_cmock + test_and_optimize/optimizing/index diff --git a/doc/nrf/getting_started/images/putty.svg b/doc/nrf/test_and_optimize/images/putty.svg similarity index 100% rename from doc/nrf/getting_started/images/putty.svg rename to doc/nrf/test_and_optimize/images/putty.svg diff --git a/doc/nrf/getting_started/images/rtt_viewer_configuration.png b/doc/nrf/test_and_optimize/images/rtt_viewer_configuration.png similarity index 100% rename from doc/nrf/getting_started/images/rtt_viewer_configuration.png rename to doc/nrf/test_and_optimize/images/rtt_viewer_configuration.png diff --git a/doc/nrf/app_dev/logging/index.rst b/doc/nrf/test_and_optimize/logging.rst similarity index 100% rename from doc/nrf/app_dev/logging/index.rst rename to doc/nrf/test_and_optimize/logging.rst diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opp_cdrx_normal.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opp_cdrx_normal.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opp_cdrx_normal.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opp_cdrx_normal.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_blink_serial_off.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_blink_serial_off.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_blink_serial_off.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_blink_serial_off.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_blinky_serial_on.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_blinky_serial_on.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_blinky_serial_on.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_blinky_serial_on.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_drx_long.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_drx_long.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_drx_long.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_drx_long.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_opp_default_20byte_10min.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_opp_default_20byte_10min.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_opp_default_20byte_10min.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_opp_default_20byte_10min.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_opp_default_40_byte_20min.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_opp_default_40_byte_20min.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_opp_default_40_byte_20min.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_opp_default_40_byte_20min.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_opp_tuned_with_measurements.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_opp_tuned_with_measurements.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_opp_tuned_with_measurements.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_opp_tuned_with_measurements.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_10sec_active_timer.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_10sec_active_timer.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_10sec_active_timer.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_10sec_active_timer.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_120_byte.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_120_byte.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_120_byte.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_120_byte.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_40_byte.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_40_byte.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_40_byte.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_40_byte.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_cdrx_duration_40ms.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_cdrx_duration_40ms.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_cdrx_duration_40ms.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_cdrx_duration_40ms.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_cdrx_interval.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_cdrx_interval.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_cdrx_interval.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_cdrx_interval.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_inactivity_timer.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_inactivity_timer.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_inactivity_timer.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_inactivity_timer.png diff --git a/doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_psm.png b/doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_psm.png similarity index 100% rename from doc/nrf/app_dev/optimizing/images/app_power_opt_ppk_psm.png rename to doc/nrf/test_and_optimize/optimizing/images/app_power_opt_ppk_psm.png diff --git a/doc/nrf/app_dev/optimizing/index.rst b/doc/nrf/test_and_optimize/optimizing/index.rst similarity index 100% rename from doc/nrf/app_dev/optimizing/index.rst rename to doc/nrf/test_and_optimize/optimizing/index.rst diff --git a/doc/nrf/app_dev/optimizing/memory.rst b/doc/nrf/test_and_optimize/optimizing/memory.rst similarity index 100% rename from doc/nrf/app_dev/optimizing/memory.rst rename to doc/nrf/test_and_optimize/optimizing/memory.rst diff --git a/doc/nrf/app_dev/optimizing/power.rst b/doc/nrf/test_and_optimize/optimizing/power.rst similarity index 100% rename from doc/nrf/app_dev/optimizing/power.rst rename to doc/nrf/test_and_optimize/optimizing/power.rst diff --git a/doc/nrf/app_dev/optimizing/power_general.rst b/doc/nrf/test_and_optimize/optimizing/power_general.rst similarity index 100% rename from doc/nrf/app_dev/optimizing/power_general.rst rename to doc/nrf/test_and_optimize/optimizing/power_general.rst diff --git a/doc/nrf/app_dev/optimizing/power_nrf9160.rst b/doc/nrf/test_and_optimize/optimizing/power_nrf9160.rst similarity index 100% rename from doc/nrf/app_dev/optimizing/power_nrf9160.rst rename to doc/nrf/test_and_optimize/optimizing/power_nrf9160.rst diff --git a/doc/nrf/getting_started/testing.rst b/doc/nrf/test_and_optimize/testing.rst similarity index 100% rename from doc/nrf/getting_started/testing.rst rename to doc/nrf/test_and_optimize/testing.rst diff --git a/doc/nrf/app_dev/testing_unity_cmock/index.rst b/doc/nrf/test_and_optimize/testing_unity_cmock.rst similarity index 100% rename from doc/nrf/app_dev/testing_unity_cmock/index.rst rename to doc/nrf/test_and_optimize/testing_unity_cmock.rst diff --git a/samples/matter/light_bulb/README.rst b/samples/matter/light_bulb/README.rst index 2552b6d1ca87..77e054f27ad3 100644 --- a/samples/matter/light_bulb/README.rst +++ b/samples/matter/light_bulb/README.rst @@ -83,7 +83,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 @@ -170,14 +170,14 @@ Before you start testing the application, you can select one of the `Matter ligh 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 diff --git a/samples/matter/light_switch/README.rst b/samples/matter/light_switch/README.rst index 00f317b7fac8..74acbacaca91 100644 --- a/samples/matter/light_switch/README.rst +++ b/samples/matter/light_switch/README.rst @@ -267,14 +267,14 @@ Before you start testing the application, you can select one of the `Matter ligh 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 diff --git a/samples/matter/lock/README.rst b/samples/matter/lock/README.rst index a8b616c5460f..7f8a9c12b18e 100644 --- a/samples/matter/lock/README.rst +++ b/samples/matter/lock/README.rst @@ -146,7 +146,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 @@ -325,14 +325,14 @@ Before you start testing the application, you can select one of the `Matter door 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 diff --git a/samples/matter/template/README.rst b/samples/matter/template/README.rst index 58a1b070dc0c..0b83740f6e8e 100644 --- a/samples/matter/template/README.rst +++ b/samples/matter/template/README.rst @@ -144,14 +144,14 @@ Before you start testing the application, you can select one of the `Matter temp 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 diff --git a/samples/matter/window_covering/README.rst b/samples/matter/window_covering/README.rst index df2319716823..ebd93b462545 100644 --- a/samples/matter/window_covering/README.rst +++ b/samples/matter/window_covering/README.rst @@ -169,14 +169,14 @@ Before you start testing the application, you can select one of the `Matter wind 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