-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
doc: new top level hierarchy #11594
doc: new top level hierarchy #11594
Conversation
b884a5e
to
668648c
Compare
41f8baf
to
798eef1
Compare
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. |
798eef1
to
5fdfcc0
Compare
Following feedback from several people, renamed "Hardware guides" to a more accurate "Device configuration guides", as the "Working with" guides or other guides in that section are more about configuring specific devices rather than SoCs and their specifications (as in hardware guides on Infocenter). |
Couple quick organizational comments: Configuring and buildingCould we reorganize this like the following? I was thinking it might make more sense to put the hardware-related topics first as contextual information before configuration.
Testing and optimizingCould we change "How to use RTT" to "How to connect using RTT"? It would be more consistent with the other headings in this section. Device configuration guidesCan we put the "Working with RF front-end modules" after the 52 series one? I think the main device guides should go first. About this documentationCan we put "Documentation build process" right before "Building the nRF Connect SDK documentation"? I think it makes sense to group those similar topics near each other. |
@Avalei , thanks for the comment. I've implemented all suggestions except:
|
5fdfcc0
to
acfaf28
Compare
Looks good! Thanks @greg-fer ! |
acfaf28
to
36fa6c5
Compare
Created new top level hierarchy pages. Moved existing pages without editing their contents. Updated include paths and redirects. This is the first task of the rework planned in NCSDK-22319. Page tags and links will be updated in the next PR. NCSDK-22320. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
36fa6c5
to
fe34728
Compare
Created new top level hierarchy pages.
Moved existing pages without editing their contents. Updated include paths and redirects.
This is the first task of the rework planned in NCSDK-22319. Page tags and links will be updated in the next PR. NCSDK-22320.
This PR only touches on conceptual documentation that is not tied directly to code.
For more information, see https://nordicsemi.atlassian.net/wiki/spaces/TECHDOC/pages/203165695/2023-06-19+-+NCS+New+top+sections