Merge pull request #42 from NordicSemiconductor/doc_014_release_updates_2

greg-fer · web-flow · commit 0b4d9da8148d · 2024-02-15T10:02:29.000+01:00
doc: update docs for v0.1.4 release
diff --git a/README.md b/README.md
@@ -1,20 +1,38 @@
-# nRF Connect Boilerplate
+# nRF Connect Board Configurator
 
 [![Build Status](https://dev.azure.com/NordicSemiconductor/Wayland/_apis/build/status/pc-nrfconnect-boilerplate?branchName=master)](https://dev.azure.com/NordicSemiconductor/Wayland/_build/latest?definitionId=10&branchName=master)
 [![License](https://img.shields.io/badge/license-Modified%20BSD%20License-blue.svg)](LICENSE)
 
-_nRF Connect Boilerplate_ provides a starting point for developing apps that can
-be launched by
-[nRF Connect for Desktop](https://github.com/NordicSemiconductor/pc-nrfconnect-launcher).
+nRF Connect Board Configurator is an application that you can use to update the
+configuration of the board controller on Nordic Development kits. The board
+controller is the firmware running on the Interface MCU that controls the
+behavior of the DK.
+
+**Note:** The current Board Configurator version is experimental. This means
+that the application is incomplete in functionality and will change in the
+future.
+
+![screenshot](resources/screenshot.gif)
+
+## Installation
+
+nRF Connect Board Configurator is installed from nRF Connect from Desktop. For
+detailed steps, see
+[Installing nRF Connect for Desktop apps](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/installing_apps.html)
+in the nRF Connect from Desktop documentation.
+
+## Documentation
+
+Read the
+[nRF Connect Board Configurator](https://docs.nordicsemi.com/bundle/nrf-connect-board-configurator/page/index.html)
+official documentation.
 
 ## Development
 
 See the
 [app development](https://nordicsemiconductor.github.io/pc-nrfconnect-docs/)
 pages for details on how to develop apps for the nRF Connect for Desktop
-framework and specifically the description
-[how to create a new app project](https://nordicsemiconductor.github.io/pc-nrfconnect-docs/create_new_app),
-to understand how you may use this project.
+framework.
 
 ## Feedback
 
diff --git a/doc/docs/index.md b/doc/docs/index.md
@@ -1,9 +1,10 @@
 # nRF Connect Board Configurator
 
-nRF Connect Board Configurator is an application that you can use to update the board configuration on Nordic Development kits.
+nRF Connect Board Configurator is an application that you can use to update the configuration of the board controller on Nordic Development kits.
+The board controller is the firmware running on the Interface MCU that controls the behavior of the DK.
 
 !!! note "Note"
-      The current Board Configurator version is experimental. This means that the application is incomplete in functionality and verification and will change in the future.
+      The current Board Configurator version is experimental. This means that the application is incomplete in functionality and will change in the future.
 
 ## Supported devices
 
diff --git a/doc/docs/installing.md b/doc/docs/installing.md
@@ -1,16 +1,3 @@
 # Installing Board Configurator app
 
-Board Configurator is installed as an app for **nRF Connect for Desktop**. Before you can install the app, you must download and install [nRF Connect for Desktop](https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Connect-for-desktop) (version 4.3.0 or later).
-
-To install the app:
-
-1. Open nRF Connect for Desktop.
-2. Find the Board Configurator app in the list and click **Install**.
-
-Once the app is installed, you can launch it by clicking **Open**.
-
-For easy access, you can create a desktop shortcut by clicking the arrow-down button and selecting **Create shortcut**.
-
-If a new version of the app becomes available, an **Update** button is displayed next to the **Open** button. Click this button to install the latest version.
-
-To uninstall the app, click the arrow-down button and select **Uninstall**.
+For installation instructions, see [Installing nRF Connect for Desktop apps](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/installing_apps.html) in the nRF Connect for Desktop documentation.
diff --git a/doc/docs/overview.md b/doc/docs/overview.md
@@ -14,7 +14,7 @@ Opens the drop-down with the list of devices connected to the computer. You can
 
 When you select a device, the following actions become available in the side panel:
 
-- **Write config** - Writes the selected configurations to the development kit.
+- **Write config** - Writes the selected configurations to the development kit, overwriting the defaults.
 
 ## Configuration tab
 
@@ -31,6 +31,10 @@ The Log panel allows you to view the most important log events, tagged with a ti
 - To hide or display the Log panel in the user interface, use **Show Log**.
 - To freeze Log panel scrolling, use **Autoscroll Log**.
 
+## Feedback tab
+
+The Feedback tab lets you send feedback about nRF Connect Board Configurator application to the application development team.
+
 ## About tab
 
 You can view application information, restore defaults, access source code, and documentation. You also can find information on the selected device, access support tools, and enable verbose logging.
diff --git a/doc/docs/revision_history.md b/doc/docs/revision_history.md
@@ -2,4 +2,5 @@
 
 | Date       | Description   |
 |------------|---------------|
+| 2024-02-15 | Updated documentation for the experimental [v0.1.4](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md) of the application. |
 | 2024-01-15 | First release, for the experimental [v0.1.0](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md) of the application. |
diff --git a/doc/docs/screenshots/board_configurator_connected.png b/doc/docs/screenshots/board_configurator_connected.png
diff --git a/doc/docs/screenshots/board_configurator_overview.png b/doc/docs/screenshots/board_configurator_overview.png
diff --git a/doc/docs/updating.md b/doc/docs/updating.md
@@ -1,12 +1,18 @@
 # Updating the board configuration
 
-In Board Configurator, you can update the configuration of a supported Nordic development kit.
+In Board Configurator, you can update the configuration of the board controller on a [supported Nordic Semiconductor Development Kit](index.md#supported-devices).
 
 To update the configuration of a development kit, complete the following steps:
 
 1. Open nRF Connect for Desktop and open nRF Connect Board Configurator.
 1. Connect a development kit to the computer with a USB cable and turn it on.
 1. Click [**Select Device**](./overview.md#select-device) and select the device from the drop-down list.</br>
-   The button text changes to the name and serial number of the selected device and the configuration options for the selected device will appear, indicating that the device is connected.
-1. Change the setting of the wanted options in the [**Configuration**](./overview.md#configuration-tab) tab.
-1. Click [**Write config**](./overview.md#actions) to upload the config to the device.
+   The application reads the Interface MCU configuration on the board.
+   The button text changes to the name and serial number of the selected device and the configuration options for the selected device appear, indicating that the device is connected.
+
+    ![Example of the configuration options](./screenshots/board_configurator_connected.png "Example of the configuration options")
+
+1. Configure the settings in the [**Configuration**](./overview.md#configuration-tab) tab.
+1. Click [**Write config**](./overview.md#actions) to upload the config to the device.</br>
+   The application overwrites the default board controller configuration with the updated settings.
+   The **Write config** button is greyed out when the upload is ongoing.
diff --git a/resources/screenshot.png b/resources/screenshot.png
