doc: link to nRF Util's erase page #26419
Conversation
Added a link to the page about Erasing the device in nRF Util docs. NCSIDB-1744. Signed-off-by: Grzegorz Ferenc <[email protected]>
NordicBuilder
added
doc-required
There was a problem hiding this comment.
Pull request overview
This PR adds a link to the nRF Util documentation page about erasing devices and improves the clarity of related instructions across documentation files. The changes enhance documentation by providing direct references to external resources and streamlining step numbering.
Key Changes:
- Added a new link definition for "Erasing the device" in the nRF Util documentation
- Updated instructions to reference the new link when describing device erase operations
- Improved formatting consistency in the "device command" link text
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| doc/nrf/links.txt | Added new link reference to nRF Util's device erasing guide |
| samples/crypto/kmu_cracen_usage/README.rst | Restructured provisioning steps to reference the new erase documentation link and improved step numbering |
| doc/nrf/app_dev/device_guides/nrf54l/kmu_provision.rst | Updated SoC erase instructions to reference the new documentation link |
| doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ironside_update.rst | Standardized "device command" link text formatting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| #. Provision the example keys to the board using nRF Util. | ||
| Complete the following steps: | ||
| #. Perform a full erase of the device. | ||
| You can use nRF Util's `device command <Erasing the device_>`_ for this purpose: |
There was a problem hiding this comment.
The link text 'device command' is inconsistent with the actual link target. The text suggests the link points to general device command documentation, but it actually points to the specific erasing guide. Consider changing the link text to something like 'erase command' or adjusting to match the pattern used in other files (e.g., line 107 of kmu_provision.rst uses the same pattern).
| You can use nRF Util's `device command <Erasing the device_>`_ for this purpose: | |
| You can use nRF Util's `erase command <Erasing the device_>`_ for this purpose: |
| Before uploading keys, ensure that the SoC is unprovisioned. | ||
| If the SoC has been previously provisioned and you need to use a different set of keys, you must first erase the SoC with the following erase command: | ||
| If the SoC has been previously provisioned and you need to use a different set of keys, you must first erase the SoC. | ||
| You can use nRF Util's `device command <Erasing the device_>`_ for this purpose: |
There was a problem hiding this comment.
The link text 'device command' is inconsistent with the actual link target. The text suggests the link points to general device command documentation, but it actually points to the specific erasing guide. Consider changing the link text to something like 'erase command' to be more specific and accurate.
| You can use nRF Util's `device command <Erasing the device_>`_ for this purpose: | |
| You can use nRF Util's `erase command <Erasing the device_>`_ for this purpose: |
CI InformationTo view the history of this post, click the 'edited' button above Inputs:Sources:more detailsGithub labels
List of changed files detected by CI (0)Outputs:ToolchainVersion: Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
|
You can find the documentation preview for this PR here. Preview links for modified nRF Connect SDK documents: https://ncsdoc.z6.web.core.windows.net/PR-26419/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ironside_update.html |
2 participants
Added a link to the page about Erasing the device in nRF Util docs. NCSIDB-1744.