diff --git a/VERSION b/VERSION index cb3e96017250..34974e7f7234 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.5.99 +2.5.99-dev1 diff --git a/doc/nrf/conf.py b/doc/nrf/conf.py index 10ccdfd47b7d..788a132dda03 100644 --- a/doc/nrf/conf.py +++ b/doc/nrf/conf.py @@ -28,7 +28,7 @@ project = "nRF Connect SDK" copyright = "2019-2023, Nordic Semiconductor" author = "Nordic Semiconductor" -version = release = "2.5.99" +version = release = "2.5.99-dev1" sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions")) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) diff --git a/doc/nrf/index.rst b/doc/nrf/index.rst index c367d52c8cd4..b607a8511cbd 100644 --- a/doc/nrf/index.rst +++ b/doc/nrf/index.rst @@ -4,6 +4,19 @@ Introduction ############ +.. important:: + + |NCS| v2.5.99-dev1 is a development tag that will be replaced by v2.6.0 in the future. + + This development tag includes the following major update: + + * Experimental support for the Matter 1.2.0 protocol, with updates including but not limited to: + + * Support for new device types such as refrigerators, room air conditioners, dishwashers, laundry washers, robotic vacuum cleaners, smoke CO alarms, air quality sensors, air purifiers, and fans. + * Support for the Intermittently Connected Devices (ICD) Management cluster. + * Support for the Product Appearance attribute in the Basic Information cluster. + * Updated documentation to reflect changes in the Matter 1.2.0 protocol. + The |NCS| is a modern, unified software development kit for building low-power wireless applications based on the Nordic Semiconductor nRF52, nRF53, nRF70, and nRF91 Series wireless devices. It supports :ref:`Microsoft Windows, Linux, and macOS ` for development. diff --git a/doc/nrf/releases_and_maturity.rst b/doc/nrf/releases_and_maturity.rst index a47cb0f9490d..4e384e5d2c22 100644 --- a/doc/nrf/releases_and_maturity.rst +++ b/doc/nrf/releases_and_maturity.rst @@ -26,7 +26,6 @@ If an issue is found in a release after it has taken place, those issues are lis releases_and_maturity/release_notes releases_and_maturity/repository_revisions releases_and_maturity/software_maturity - releases_and_maturity/known_issues Migration guides **************** diff --git a/doc/nrf/releases_and_maturity/known_issues.rst b/doc/nrf/releases_and_maturity/known_issues.rst index a30f9704de4d..7f70e8217647 100644 --- a/doc/nrf/releases_and_maturity/known_issues.rst +++ b/doc/nrf/releases_and_maturity/known_issues.rst @@ -1,3 +1,5 @@ +:orphan: + .. _known_issues: Known issues diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst index 15c149135507..15d31ff2c218 100644 --- a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst +++ b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst @@ -1,7 +1,7 @@ .. _ncs_release_notes_changelog: -Changelog for |NCS| v2.5.99 -########################### +Changelog for |NCS| v2.5.99-dev1 +################################ .. contents:: :local: @@ -84,9 +84,7 @@ Bluetooth mesh Matter ------ -* Updated: - - * Page about :ref:`ug_matter_device_low_power_configuration` with the information about Intermittently Connected Devices (ICD) configuration. +* Updated the page about :ref:`ug_matter_device_low_power_configuration` with the information about Intermittently Connected Devices (ICD) configuration. Matter fork +++++++++++ @@ -101,14 +99,14 @@ The following list summarizes the most important changes inherited from the upst * The Kconfig options :kconfig:option:`CONFIG_CHIP_ICD_IDLE_MODE_DURATION`, :kconfig:option:`CONFIG_CHIP_ICD_ACTIVE_MODE_DURATION` and :kconfig:option:`CONFIG_CHIP_ICD_CLIENTS_PER_FABRIC` to manage ICD configuration. * New device types: - * Refidgerator - * Room Air Conditioner + * Refridgerator + * Room air conditioner * Dishwasher - * Laundry Washer - * Robotic Vacuum Cleaner - * Smoke CO Alarm - * Air Quality Sensor - * Air Purifier + * Laundry washer + * Robotic vacuum cleaner + * Smoke CO alarm + * Air quality sensor + * Air purifier * Fan * Product Appearance attribute in the Basic Information cluster that allows describing the product's color and finish. @@ -120,7 +118,6 @@ The following list summarizes the most important changes inherited from the upst * Renamed the ``CONFIG_CHIP_SED_ACTIVE_INTERVAL`` Kconfig option to :kconfig:option:`CONFIG_CHIP_ICD_FAST_POLLING_INTERVAL`. * Renamed the ``CONFIG_CHIP_SED_ACTIVE_THRESHOLD`` Kconfig option to :kconfig:option:`CONFIG_CHIP_ICD_ACTIVE_MODE_THRESHOLD`. - Thread ------ @@ -177,14 +174,11 @@ Serial LTE modem * ``#XMQTTCON`` AT command to exclude MQTT client ID from the parameter list. * ``#XSLMVER`` AT command to report CONFIG_SLM_CUSTOMER_VERSION if it is defined. -* Removed: - * The ``CONFIG_SLM_CUSTOMIZED`` Kconfig option due to it no longer being used. - * The ``CONFIG_SLM_SOCKET_RX_MAX`` Kconfig option due to it no longer being used. +* Removed Kconfig options ``CONFIG_SLM_CUSTOMIZED`` and ``CONFIG_SLM_SOCKET_RX_MAX``. nRF5340 Audio ------------- - |no_changes_yet_note| nRF Machine Learning (Edge Impulse) @@ -219,8 +213,6 @@ This section provides detailed lists of changes by :ref:`sample `. Bluetooth samples ----------------- -|no_changes_yet_note| - * :ref:`ble_throughput` sample: * Enabled encryption in the sample. @@ -249,7 +241,7 @@ Cellular samples (renamed from nRF9160 samples) * Changed: - * The sample now explicitly uses :c:func:`conn_mgr_all_if_connect` to start network connectivity, instead of the :kconfig:option:`CONFIG_NRF_MODEM_LIB_NET_IF_AUTO_START` and :kconfig:option:`CONFIG_NRF_MODEM_LIB_NET_IF_AUTO_CONNECT` Kconfig options. + * The sample now explicitly uses the :c:func:`conn_mgr_all_if_connect` function to start network connectivity, instead of the :kconfig:option:`CONFIG_NRF_MODEM_LIB_NET_IF_AUTO_START` and :kconfig:option:`CONFIG_NRF_MODEM_LIB_NET_IF_AUTO_CONNECT` Kconfig options. * :ref:`nrf_cloud_rest_fota` sample: @@ -267,8 +259,6 @@ Cryptography samples * All crypto samples to use ``psa_key_id_t`` instead of ``psa_key_handle_t``. These concepts have been merged and ``psa_key_handle_t`` is removed from the PSA API specification. -|no_changes_yet_note| - Debug samples ------------- @@ -315,8 +305,6 @@ Networking samples * Updated by moving the sample from :file:`cellular/coap_client` folder to :file:`net/coap_client`. The documentation is now found in the :ref:`networking_samples` section. -|no_changes_yet_note| - NFC samples ----------- @@ -355,6 +343,8 @@ Thread samples Sensor samples -------------- +|no_changes_yet_note| + Zigbee samples -------------- @@ -375,14 +365,12 @@ Drivers This section provides detailed lists of changes by :ref:`driver `. -|no_changes_yet_note| - Wi-Fi drivers ------------- * OS agnostic code is moved to |NCS| (``sdk-nrfxlib``) repository. - - Low-level API documentation is now available on the :ref:`Wi-Fi driver API `. + * Low-level API documentation is now available on the :ref:`Wi-Fi driver API `. Libraries ========= @@ -433,25 +421,20 @@ Modem libraries * The :c:func:`lte_lc_init_and_connect_async` function is deprecated. Use the :c:func:`lte_lc_connect_async` function instead. - * Removed: - - * The deprecated Kconfig option ``CONFIG_LTE_AUTO_INIT_AND_CONNECT``. + * Removed the deprecated Kconfig option ``CONFIG_LTE_AUTO_INIT_AND_CONNECT``. * :ref:`nrf_modem_lib_readme`: * Added: * A mention about enabling TF-M logging while using modem traces in the :ref:`modem_trace_module`. - * The :kconfig:option:`CONFIG_NRF_MODEM_LIB_NET_IF_DOWN_DEFAULT_LTE_DISCONNECT` option, allowing the :c:enumerator:`nrf_modem_lib_net_if_options.NRF_MODEM_LIB_NET_IF_DOWN` option to be set to :c:enumerator:`~nrf_modem_lib_net_if_down_options.NRF_MODEM_LIB_NET_IF_DOWN_LTE_DISCONNECT` at build time. + * The :kconfig:option:`CONFIG_NRF_MODEM_LIB_NET_IF_DOWN_DEFAULT_LTE_DISCONNECT` Kconfig option, allowing the :c:enumerator:`nrf_modem_lib_net_if_options.NRF_MODEM_LIB_NET_IF_DOWN` option to be set to :c:enumerator:`~nrf_modem_lib_net_if_down_options.NRF_MODEM_LIB_NET_IF_DOWN_LTE_DISCONNECT` at build time. * Updated by renaming ``lte_connectivity`` module to ``lte_net_if``. All related Kconfig options have been renamed accordingly. * Changed the default value of the :kconfig:option:`CONFIG_NRF_MODEM_LIB_NET_IF_AUTO_START`, :kconfig:option:`CONFIG_NRF_MODEM_LIB_NET_IF_AUTO_CONNECT`, and :kconfig:option:`CONFIG_NRF_MODEM_LIB_NET_IF_AUTO_DOWN` Kconfig options from enabled to disabled. - * Removed: - - * The deprecated Kconfig option ``CONFIG_NRF_MODEM_LIB_SYS_INIT``. - * The deprecated Kconfig option ``CONFIG_NRF_MODEM_LIB_IPC_IRQ_PRIO_OVERRIDE``. + * Removed the deprecated Kconfig options ``CONFIG_NRF_MODEM_LIB_SYS_INIT`` and ``CONFIG_NRF_MODEM_LIB_IPC_IRQ_PRIO_OVERRIDE``. * :ref:`lib_modem_slm`: @@ -602,9 +585,12 @@ Documentation * Updated: - * The :ref:`installation` section: by replacing two separate pages about installing the |NCS| with just one (:ref:`install_ncs`). + * The :ref:`installation` section by replacing two separate pages about installing the |NCS| with just one (:ref:`install_ncs`). * The :ref:`requirements` page with new sections about :ref:`requirements_clt` and :ref:`toolchain_management_tools`. * The :ref:`ug_nrf9160_gs` and :ref:`ug_thingy91_gsg` pages so that instructions in the :ref:`nrf9160_gs_connecting_dk_to_cloud` and :ref:`thingy91_connect_to_cloud` sections, respectively, match the updated nRF Cloud workflow. * The :ref:`ug_nrf9160_gs` by replacing the Updating the DK firmware section with a new :ref:`nrf9160_gs_installing_software` section. This new section includes steps for using Quick Start, a new application in `nRF Connect for Desktop`_ that streamlines the getting started process with the nRF91 Series DKs. - * Updated the :ref:`tfm_enable_share_uart` section on :ref:`ug_nrf9160`. + * The :ref:`tfm_enable_share_uart` section on :ref:`ug_nrf9160`. + +* Removed the Welcome to the |NCS| page. + This page is replaced with existing :ref:`ncs_introduction` page. diff --git a/doc/versions.json b/doc/versions.json index c10ab1527c77..9443679d28fd 100644 --- a/doc/versions.json +++ b/doc/versions.json @@ -1,5 +1,6 @@ [ "2.5.99", + "2.5.99-dev1", "2.5.0", "2.4.2", "2.4.1",