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: update docs for v0.1.4 release #42

Merged
merged 3 commits into from
Feb 15, 2024
Merged

Conversation

greg-fer
Copy link
Contributor

@greg-fer greg-fer commented Feb 9, 2024

Updated text and screenshots for the release.
Updated README.md.
NCD-722 and PRs #29 and #36.

@greg-fer greg-fer added documentation Improvements or additions to documentation. doc required This PR includes user-facing changes that need to be documented. labels Feb 9, 2024
@greg-fer greg-fer requested a review from cybic February 9, 2024 09:23
Updated text and screenshots for the release.
Updated README.md.
NCD-722.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@greg-fer greg-fer force-pushed the doc_014_release_updates_2 branch from d8de64f to 930c9f6 Compare February 9, 2024 10:21
Copy link
Contributor

@cybic cybic left a comment

Choose a reason for hiding this comment

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

Well done!

Only one important note about wrong name, but some additional comments for your consideration.

README.md Outdated
behavior of the DK.

**Note:** The current Board Configurator version is experimental. This means
that the application is incomplete in functionality and verification and will
Copy link
Contributor

Choose a reason for hiding this comment

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

W: I don't quite understand what "incomplete in verification" means, might be unclear for other people as well.

@@ -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 Cellular Monitor application to the application development team.
Copy link
Contributor

Choose a reason for hiding this comment

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

M: Board Configurator, not Cellular Monitor :)

@@ -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 by overwriting the defaults from the board definition file.
Copy link
Contributor

Choose a reason for hiding this comment

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

W: I would simply say "Writes the selected configurations to the development kit, overwriting the defaults." I'm not sure the user is supposed to care about the board definition files, but it might be.

Signed-off-by: Grzegorz Ferenc <[email protected]>
Signed-off-by: Grzegorz Ferenc <[email protected]>
@greg-fer greg-fer force-pushed the doc_014_release_updates_2 branch from aa56a09 to 1aedc7d Compare February 15, 2024 08:52
@greg-fer greg-fer merged commit 0b4d9da into main Feb 15, 2024
3 checks passed
@greg-fer greg-fer deleted the doc_014_release_updates_2 branch February 15, 2024 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc required This PR includes user-facing changes that need to be documented. documentation Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants