doc: introduction: distinguishing NCS features #12219

greg-fer · 2023-09-01T12:17:46Z

Edited the introduction page to include distinguishing features similar to the section in Zephyr docs.
NCSDK-22322.

Approval from @wbober

NordicBuilder · 2023-09-01T13:00:21Z

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

wbober · 2023-09-29T07:49:08Z

doc/nrf/introduction.rst

+   The |NCS| supports a wide range of connectivity technologies, such as Ant, Bluetooth® Low Energy, Bluetooth mesh, LTE-M/NB-IoT/GPS, Matter, Sidewalk, TCP/IP, Thread, and Wi-Fi®.
+
+**Third-party integrations**
+   The |NCS| allows for using third-party and Nordic products within the SDK, such as AWS, nRFCloud, memfault, and more.


Suggested change

The |NCS| allows for using third-party and Nordic products within the SDK, such as AWS, nRFCloud, memfault, and more.

The |NCS| provides integrations with third-party and Nordic products within the SDK, such as AWS, nRFCloud, memfault, and more.

wbober · 2023-09-29T07:49:46Z

doc/nrf/introduction.rst

+   The |NCS| is optimized for pre-certified libraries, including SoftDevice, Matter, and Thread.
+
+**Robust connectivity support**
+   The |NCS| supports a wide range of connectivity technologies, such as Ant, Bluetooth® Low Energy, Bluetooth mesh, LTE-M/NB-IoT/GPS, Matter, Sidewalk, TCP/IP, Thread, and Wi-Fi®.


"In addition to connectivity technologies provided by Zephyr [list] it supports [list]".

wbober · 2023-09-29T07:50:13Z

doc/nrf/introduction.rst

+   The |NCS| offers an extensible framework for building size-optimized software for memory-constrained devices as well as powerful and complex software for more advanced devices and applications.
+
+**Pre-certified libraries**
+   The |NCS| is optimized for pre-certified libraries, including SoftDevice, Matter, and Thread.


Provided pre-certified and optimized libraries.

wbober · 2023-09-29T07:50:30Z

doc/nrf/introduction.rst

+   The |NCS| integrates the Zephyr™ real-time operating system (RTOS) and a wide range of complete applications and samples.
+
+**Extensible framework**
+   The |NCS| offers an extensible framework for building size-optimized software for memory-constrained devices as well as powerful and complex software for more advanced devices and applications.


I'd remove this. Let's be concrete in this list.

wbober · 2023-09-29T07:50:44Z

doc/nrf/introduction.rst

+   The |NCS| includes middleware such as CoAP, MQTT, LwM2M, various libraries, hardware drivers, Trusted Firmware-M for security, and a secure bootloader (MCUboot).
+
+**Based on Zephyr**
+   The |NCS| integrates the Zephyr™ real-time operating system (RTOS) and a wide range of complete applications and samples.


Put as the first point. Refer to the distinguishing features of Zephyr.

wbober · 2023-09-29T07:52:38Z

doc/nrf/introduction.rst


-The |NCS| supports :ref:`Microsoft Windows, Linux, and macOS <requirements>` for development.
+**Advanced middleware and security**
+   The |NCS| includes middleware such as CoAP, MQTT, LwM2M, various libraries, hardware drivers, Trusted Firmware-M for security, and a secure bootloader (MCUboot).


In addition to middleware provided by Zephyr, adds extra libraries such as [list only these that are not available upstream].

Added some, but would appreciate a more thorough look at this.

greg-fer · 2023-10-04T12:44:09Z

@wbober , I won't request merge until your sign-off on this one (when you're back).

b-gent · 2023-10-09T11:58:03Z

doc/nrf/introduction.rst

+
+**Robust connectivity support**
+   The |NCS| supports a wide range of connectivity technologies.
+   In addition to connectivity technologies :ref:`provided by Zephyr <zephyr:connectivity>`, such as Bluetooth® Low Energy, IPv6, TCP/IP, UDP, LoRa and LoRaWAN, the |NCS| supports Ant, Bluetooth mesh, Find My, HomeKit, LTE-M/NB-IoT/GPS, Matter, Sidewalk, Thread, and Wi-Fi®, among others.


Suggested change

In addition to connectivity technologies :ref:`provided by Zephyr <zephyr:connectivity>`, such as Bluetooth® Low Energy, IPv6, TCP/IP, UDP, LoRa and LoRaWAN, the |NCS| supports Ant, Bluetooth mesh, Find My, HomeKit, LTE-M/NB-IoT/GPS, Matter, Sidewalk, Thread, and Wi-Fi®, among others.

In addition to connectivity technologies :ref:`provided by Zephyr <zephyr:connectivity>`, such as Bluetooth® Low Energy, IPv6, TCP/IP, UDP, LoRa and LoRaWAN, the |NCS| supports ANT, Bluetooth mesh, Apple Find My, Apple HomeKit, LTE-M/NB-IoT/GPS, Matter, Amazon Sidewalk, Thread, and Wi-Fi®, among others.

b-gent · 2023-10-09T12:00:22Z

doc/nrf/introduction.rst

+   In addition to that, the |NCS| adds extra libraries and drivers, such as CoAP, LwM2M, a secure bootloader (MCUboot), Mbed TLS, nRF 802.15.4 Radio Driver, nRF Security, nRF Profiler, nRF Remote procedure call libraries, and many more.
+
+**Pre-certified libraries**
+   The |NCS| provides pre-certified and optimized libraries, including for SoftDevice, Matter, and Thread.


I'm pretty sure this syntax isn't entirely correct.

b-gent · 2023-10-09T12:04:17Z

doc/nrf/introduction.rst

+   The |NCS| is out-of-tree ready and can be used for projects and applications of all sizes and levels of complexity.
+
+**Third-party integrations**
+   The |NCS| provides integrations with third-party and Nordic products within the SDK, such as AWS, nRFCloud, memfault, and more.


Suggested change

The |NCS| provides integrations with third-party and Nordic products within the SDK, such as AWS, nRFCloud, memfault, and more.

The |NCS| provides integrations with third-party and Nordic products within the SDK, such as AWS, nRF Cloud, Memfault, and more.

Edited the introduction page to include distinguishing features similar to the section in Zephyr docs. NCSDK-22322. Signed-off-by: Grzegorz Ferenc <[email protected]>

greg-fer added the DNM label Sep 1, 2023

github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Sep 1, 2023

greg-fer added the CI-disable Disable CI for this PR label Sep 1, 2023

greg-fer force-pushed the doc_new_intro_page_ver1 branch from b5574bd to 3515e4e Compare September 21, 2023 08:17

greg-fer force-pushed the doc_new_intro_page_ver1 branch from 3515e4e to 7127e6b Compare September 28, 2023 12:52

greg-fer changed the title ~~[WIP] doc: introduction: proposal 1 for main page rework~~ doc: introduction: distinguishing NCS features Sep 28, 2023

greg-fer requested review from wbober, bjorn-tore-taraldsen and ihansse September 28, 2023 12:53

greg-fer removed doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Sep 28, 2023

greg-fer marked this pull request as ready for review September 28, 2023 12:54

greg-fer requested a review from carlescufi as a code owner September 28, 2023 12:54

greg-fer requested review from reidarma, pdunaj and DeidreCasey September 28, 2023 12:54

wbober reviewed Sep 29, 2023

View reviewed changes

greg-fer force-pushed the doc_new_intro_page_ver1 branch from 7127e6b to c74e842 Compare October 2, 2023 11:30

github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Oct 2, 2023

greg-fer force-pushed the doc_new_intro_page_ver1 branch 2 times, most recently from 9a9ecb0 to e8f1ede Compare October 2, 2023 14:48

ihansse approved these changes Oct 3, 2023

View reviewed changes

DeidreCasey approved these changes Oct 4, 2023

View reviewed changes

greg-fer force-pushed the doc_new_intro_page_ver1 branch from e8f1ede to 0451276 Compare October 4, 2023 10:38

carlescufi approved these changes Oct 4, 2023

View reviewed changes

wbober self-requested a review October 9, 2023 08:52

wbober approved these changes Oct 9, 2023

View reviewed changes

greg-fer removed DNM doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Oct 9, 2023

b-gent requested changes Oct 9, 2023

View reviewed changes

greg-fer force-pushed the doc_new_intro_page_ver1 branch from 0451276 to 6f4ffec Compare October 9, 2023 12:09

github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Oct 9, 2023

doc: introduction: distinguishing NCS features

6f4ffec

Edited the introduction page to include distinguishing features similar to the section in Zephyr docs. NCSDK-22322. Signed-off-by: Grzegorz Ferenc <[email protected]>

b-gent approved these changes Oct 9, 2023

View reviewed changes

rlubos merged commit a30d044 into nrfconnect:main Oct 9, 2023
12 checks passed

greg-fer deleted the doc_new_intro_page_ver1 branch October 9, 2023 13:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: introduction: distinguishing NCS features #12219

doc: introduction: distinguishing NCS features #12219

greg-fer commented Sep 1, 2023 •

edited

Loading

NordicBuilder commented Sep 1, 2023

wbober Sep 29, 2023

wbober Sep 29, 2023

wbober Sep 29, 2023

wbober Sep 29, 2023 •

edited

Loading

wbober Sep 29, 2023 •

edited

Loading

wbober Sep 29, 2023

greg-fer Oct 2, 2023

greg-fer commented Oct 4, 2023 •

edited

Loading

b-gent Oct 9, 2023

b-gent Oct 9, 2023

b-gent Oct 9, 2023

	The \|NCS\| allows for using third-party and Nordic products within the SDK, such as AWS, nRFCloud, memfault, and more.
	The \|NCS\| provides integrations with third-party and Nordic products within the SDK, such as AWS, nRFCloud, memfault, and more.

	In addition to connectivity technologies :ref:`provided by Zephyr <zephyr:connectivity>`, such as Bluetooth® Low Energy, IPv6, TCP/IP, UDP, LoRa and LoRaWAN, the \|NCS\| supports Ant, Bluetooth mesh, Find My, HomeKit, LTE-M/NB-IoT/GPS, Matter, Sidewalk, Thread, and Wi-Fi®, among others.
	In addition to connectivity technologies :ref:`provided by Zephyr <zephyr:connectivity>`, such as Bluetooth® Low Energy, IPv6, TCP/IP, UDP, LoRa and LoRaWAN, the \|NCS\| supports ANT, Bluetooth mesh, Apple Find My, Apple HomeKit, LTE-M/NB-IoT/GPS, Matter, Amazon Sidewalk, Thread, and Wi-Fi®, among others.

doc: introduction: distinguishing NCS features #12219

doc: introduction: distinguishing NCS features #12219

Conversation

greg-fer commented Sep 1, 2023 • edited Loading

NordicBuilder commented Sep 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wbober Sep 29, 2023 • edited Loading

Choose a reason for hiding this comment

wbober Sep 29, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg-fer commented Oct 4, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg-fer commented Sep 1, 2023 •

edited

Loading

wbober Sep 29, 2023 •

edited

Loading

wbober Sep 29, 2023 •

edited

Loading

greg-fer commented Oct 4, 2023 •

edited

Loading