Documentation structure
The documentation consists of several inter-linked documentation sets, one for each repository.
The entry point is the nRF Connect SDK documentation that you are currently reading. The local Zephyr documentation is a slightly extended version of the official Zephyr Project documentation, containing some additions specific to Nordic Semiconductor. The local MCUboot documentation is a slightly extended version of the official MCUboot documentation, containing some additions specific to Nordic Semiconductor.
You can switch between these documentation sets by using the selector in the bottom-left corner of each documentation page.
nRF Connect SDK documentation set selector
Following are the available documentation sets:
nrf: nRF Connect SDKnrfx: nrfxnrfxlib: nrfxlibzephyr: Zephyr RTOSmcuboot: MCUboottfm: Trusted Firmware-Mmatter: Matterkconfig: All available Kconfig options in the nRF Connect SDK
Since there are links from the nRF Connect SDK documentation set into other documentation sets, the documentation is built in a predefined order, also when you build it manually.
Documentation search
Use the Search docs field in the top-left corner of each documentation page to search for a given word or phrase in all the documentation sets. The search engine only looks up the perfect matches for each word or phrase.
nRF Connect SDK documentation search field
The results are displayed for all documentation sets, with each search result entry prefixed with the name of the documentation set in which the result is found. For example, the search result “nRF Connect SDK » Getting started” refers to the Getting Started page from the “nRF Connect SDK” documentation set. The search match is highlighted.
nRF Connect SDK documentation search result entry
Different set versions
Some documentation sets are available in different versions. Use the version drop-down in the top-left corner of each documentation page to change the documentation version.
nRF Connect SDK documentation version drop-down
The version drop-down is displayed only if the documentation files are organized in the required folder structure and the documentation is hosted on a web server. You can test the different versions locally when you build the documentation.