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

doc: new top level hierarchy #11594

Merged
merged 1 commit into from
Jun 28, 2023

Conversation

greg-fer
Copy link
Contributor

@greg-fer greg-fer commented Jun 21, 2023

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


  • Make the doc build green
  • Make the compliance checker happy --> Created follow-up tasks for image resizing, as it is not in scope of this PR: NCSIDB-1026, NCSIDB-1027, and NCSIDB-1028
  • Add changelog entry once the approvals are in

@greg-fer greg-fer added the CI-disable Disable CI for this PR label Jun 21, 2023
@github-actions 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 Jun 21, 2023
@greg-fer greg-fer force-pushed the doc_reorganize_top_level_sections branch 9 times, most recently from b884a5e to 668648c Compare June 23, 2023 07:32
@greg-fer greg-fer force-pushed the doc_reorganize_top_level_sections branch 11 times, most recently from 41f8baf to 798eef1 Compare June 26, 2023 11:36
@NordicBuilder
Copy link
Contributor

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.

@greg-fer greg-fer force-pushed the doc_reorganize_top_level_sections branch from 798eef1 to 5fdfcc0 Compare June 26, 2023 15:10
@greg-fer
Copy link
Contributor Author

greg-fer commented Jun 26, 2023

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).

@DeidreCasey
Copy link
Contributor

Couple quick organizational comments:

Configuring and building

Could 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.

  • Board support
  • Pin control
  • Build and configuration system
  • Building and programming an application
  • Modifying an application
  • Multi-image builds
  • Bootloaders and Device Firmware Updates

Testing and optimizing

Could 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 guides

Can 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 documentation

Can 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.

@greg-fer
Copy link
Contributor Author

@Avalei , thanks for the comment. I've implemented all suggestions except:

  • Change "How to use RTT" to "How to connect using RTT" -- this I will do in NCSDK-22325
  • Put Board and Configuration System page after Board support and Pin control -- I want to keep the overview page at the very top, as it introduces concepts discuss also on Pin control

@greg-fer greg-fer force-pushed the doc_reorganize_top_level_sections branch from 5fdfcc0 to acfaf28 Compare June 27, 2023 10:31
@umapraseeda
Copy link
Contributor

Looks good! Thanks @greg-fer !

@greg-fer greg-fer force-pushed the doc_reorganize_top_level_sections branch from acfaf28 to 36fa6c5 Compare June 28, 2023 06:54
@greg-fer greg-fer removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jun 28, 2023
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>
@greg-fer greg-fer force-pushed the doc_reorganize_top_level_sections branch from 36fa6c5 to fe34728 Compare June 28, 2023 09:04
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jun 28, 2023
@greg-fer greg-fer removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jun 28, 2023
@rlubos rlubos merged commit 43b92e6 into nrfconnect:main Jun 28, 2023
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI-disable Disable CI for this PR doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants