Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

net: doc: Minor improvements on enabling application libraries #66152

Conversation

rlubos
Copy link
Contributor

@rlubos rlubos commented Dec 5, 2023

Some minor improvements for the networking documentation, suggested by the community.

Several application protocol libraries documentation missed information
on how can they be enabled (i. e. missed info about associated Kconfig
symbol). This commit fixes it.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
@rlubos rlubos requested review from kartben, wbober and jukkar December 5, 2023 12:02
@rlubos rlubos force-pushed the net/docs-improvements-on-enabling-app-libs branch from 293b57a to 7608ace Compare December 5, 2023 12:35
Copy link
Collaborator

@kartben kartben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Just one ask regarding redirect for the now removed page.

jukkar
jukkar previously approved these changes Dec 5, 2023
The Network Connectivity API page is kind of pointless, as it provides
little information (which can be found elsewhere as well) and it was
pointer out that it kind of creates noise in the documentation as it can
be confused with the page which provides a summary of network APIs.

Therefore, remove the page, and move the information from it elsewhere.
The brief summary of what APIs to use was moved the Networking APIs
index page. The information about the samples demonstrating BSD sockets
API usage was moved to the BSD sockets documentation page itself.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
@fabiobaltieri fabiobaltieri merged commit ffc4251 into zephyrproject-rtos:main Dec 7, 2023
16 checks passed
@rlubos rlubos deleted the net/docs-improvements-on-enabling-app-libs branch December 8, 2023 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants