Merge pull request #482 from NordicSemiconductor/doc_rename_app_other…

…_edits doc: rename app + other edits
NordicSemiconductor · Nov 13, 2024 · 311a7d2 · 311a7d2
2 parents a9764a7 + 5ed09ff
commit 311a7d2
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 31 deletions.
diff --git a/.github/workflows/zoomin-publish.yml b/.github/workflows/zoomin-publish.yml
@@ -1,4 +1,4 @@
-name: Publish documentation to Zoomin
+name: Publish documentation to Zoomin prod
 
 on:
   workflow_dispatch:

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# nRF Connect Power Profiler
+# Power Profiler app
 
-nRF Connect Power Profiler is a tool to communicate with the
+The Power Profiler app is a tool to communicate with the
 [Power Profiler Kit II (PPK2)](https://www.nordicsemi.com/Software-and-tools/Development-Tools/Power-Profiler-Kit-2),
 an affordable and flexible tool to obtain real-time current measurements of your
 designs.
@@ -14,23 +14,23 @@ user application.
 The support for
 [Power Profiler Kit (PPK1)](https://www.nordicsemi.com/Software-and-tools/Development-Tools/Power-Profiler-Kit)
 has been deprecated since the
-[nRF Connect Power Profiler v4.0.0-beta1](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md).
+[Power Profiler app v4.0.0-beta1](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md).
 The last application version to support PPK1 is
 [v3.5.5](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md)
 with
 [nRF Connect for Desktop v4.4.0](https://github.com/NordicSemiconductor/pc-nrfconnect-launcher/blob/main/Changelog.md).
 
 ## Installation
 
-nRF Connect Power Profiler is installed from nRF Connect from Desktop. For
+The Power Profiler app 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 Power Profiler](https://docs.nordicsemi.com/bundle/nrf-connect-ppk/page/index.html)
+[Power Profiler app](https://docs.nordicsemi.com/bundle/nrf-connect-ppk/page/index.html)
 official documentation for information about its UI and features.
 
 (The documentation is valid for PPK2. If you use the first version of the

diff --git a/doc/docs/index.md b/doc/docs/index.md
@@ -1,6 +1,6 @@
-# nRF Connect Power Profiler
+# {{app_name}}
 
-nRF Connect Power Profiler is an app available from [nRF Connect for Desktop](https://nordic-dev.zoominsoftware.io/bundle/nrf-connect-desktop/page/index.html) that you can use to communicate with the Power Profiler Kit II (PPK2) in order to obtain real-time current measurements of your designs.
+The {{app_name}} in [nRF Connect for Desktop](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/index.html) lets you communicate with the Power Profiler Kit II (PPK2) in order to obtain real-time current measurements of your designs.
 
 The PPK measures current consumption for a connected Nordic Development Kit or any external board. It gives a detailed picture of the current profile for the user application.
 
@@ -10,5 +10,5 @@ The PPK measures current consumption for a connected Nordic Development Kit or a
 
 ## Deprecated support
 
-The support for [Power Profiler Kit (PPK1)](https://www.nordicsemi.com/Software-and-tools/Development-Tools/Power-Profiler-Kit) has been deprecated since the [nRF Connect Power Profiler v4.0.0-beta1](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md). The last application version to support PPK1 is [v3.5.5](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md) with [nRF Connect for Desktop v4.4.0](https://github.com/NordicSemiconductor/pc-nrfconnect-launcher/blob/main/Changelog.md).
+The support for [Power Profiler Kit (PPK1)](https://www.nordicsemi.com/Software-and-tools/Development-Tools/Power-Profiler-Kit) has been deprecated since the [Power Profiler app v4.0.0-beta1](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md). The last application version to support PPK1 is [v3.5.5](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md) with [nRF Connect for Desktop v4.4.0](https://github.com/NordicSemiconductor/pc-nrfconnect-launcher/blob/main/Changelog.md).
 If you use the first version of the hardware, see the [online documentation for PPK1](https://docs.nordicsemi.com/bundle/ug_ppk/page/UG/ppk/PPK_user_guide_Intro.html).
diff --git a/doc/docs/installing.md b/doc/docs/installing.md
@@ -1,3 +1,3 @@
-# Installing the Power Profiler app
+# Installing the {{app_name}}
 
 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
@@ -1,8 +1,8 @@
 # Overview and user interface
 
-The nRF Connect Power Profiler app has two views that provide detailed power consumption information.
+The {{app_name}} has two views that provide detailed power consumption information.
 
-![nRF Connect Power Profiler default view at startup](./screenshots/ppk2_standard_view.png "nRF Connect Power Profiler default view at startup")
+![{{app_name}} default view at startup](./screenshots/ppk2_standard_view.png "{{app_name}} default view at startup")
 
 ## Select Device
 
@@ -41,7 +41,7 @@ The sampling will automatically stop when the hard drive has less than the defin
 
 More options become available after selecting a device. Some options are specific to the chosen sampling mode.
 
-![nRF Connect Power Profiler default view after selecting a device](./screenshots/ppk2_standard_view_connected.png "nRF Connect Power Profiler default view after selecting a device")
+![{{app_name}} default view after selecting a device](./screenshots/ppk2_standard_view_connected.png "{{app_name}} default view after selecting a device")
 
 ### Power supply mode
 
@@ -114,7 +114,7 @@ The following options let you save the results of the sampling. They are only av
 
 | Option                            | Description                                                                                          |
 |-----------------------------------|------------------------------------------------------------------------------------------------------|
-| **Save/Export**                   | Available only after sampling is stopped. Saves the results of the data sampling to a `.ppk2` file, which you can [**Load**](#device-panel-sections) in a new session of nRF Connect Power Profiler. |
+| **Save/Export**                   | Available only after sampling is stopped. Saves the results of the data sampling to a `.ppk2` file, which you can [**Load**](#device-panel-sections) in a new session of the {{app_name}}. |
 | **Screenshot**                    | Saves the current data from either the **Data logger** or the **Scope** view as a PNG image.                                          |
 
 ### Advanced configuration
@@ -147,7 +147,7 @@ Use this control to set the voltage limit for the measurement.
 
 ## Sampling mode tabs
 
-nRF Connect Power Profiler comes with two sampling modes: **Data logger** and **Scope**.
+The {{app_name}} comes with two sampling modes: **Data logger** and **Scope**.
 
 - The **Data logger** sampling mode lets you examine the power continuously over a period of time.
   It has its own [sampling parameters](#data-logger-parameters) and lets you use the **Live Now** toggle to jump back to displaying the live measurement.
@@ -217,13 +217,13 @@ To select which digital channels you see, use the **Digital channels** menu in [
 
 ## Feedback tab
 
-The Feedback tab lets you send feedback about nRF Connect Power Profiler application to the application development team.
+The Feedback tab lets you send feedback about the {{app_name}} to the application development team.
 
 ## About tab
 
 Here you can view application information, restore settings to default, access source code, and documentation. You also can find information on the selected device, access support tools, and enable verbose logging.
 
-![nRF Connect for Desktop Power Profiler About tab](./screenshots/ppk2_about_tab.png "nRF Connect for Desktop Power Profiler About tab")
+![{{app_name}} About tab](./screenshots/ppk2_about_tab.png "{{app_name}} About tab")
 
 ## Log
 

diff --git a/doc/docs/revision_history.md b/doc/docs/revision_history.md
@@ -2,10 +2,11 @@
 
 | Date       | Description                                                                                          |
 |------------|------------------------------------------------------------------------------------------------------|
-| 2024-03-14 | Updated the documentation for the nRF Connect Power Profiler [v4.0.0](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md).    |
-| 2024-02-07 | Separated the application documentation from the [PPK2 hardware documentation](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/PPK_user_guide_Intro.html).    |
-| 2022-08-16 | Updated the following topics based on nRF9160 DK v0.9.0 or later:</br></br>- Quick start</br></br>- [Measuring current in Source Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_source_meter.html)</br></br>- [Measuring current in Ampere Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_ampere_meter.html) |
-| 2021-11-01 | - Updated [Measuring current in Ampere Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_ampere_meter.html)</br></br>- Editorial changes     |
-| 2021-06-08 | Updated Pin connections in Ampere Meter mode                                                         |
-| 2021-02-26 | - Updated [Using the Power Profiler app](using_ppk_app.md)</br></br>- Updated [Measuring current in Source Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_source_meter.html)</br></br>- Updated [Measuring current in Ampere Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_ampere_meter.html)</br></br>- Added [Views](overview.md)</br></br>- Editorial changes     |
-| 2020-12-01 | First release                                                                                        |
+| November 2024 | Editorial changes   |
+| March 2024 | Updated the documentation for the {{app_name}} [v4.0.0](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md)    |
+| February 2024 | Separated the application documentation from the [PPK2 hardware documentation](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/PPK_user_guide_Intro.html)    |
+| August 2022 | Updated the following topics based on nRF9160 DK v0.9.0 or later:</br></br>- Quick start</br></br>- [Measuring current in Source Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_source_meter.html)</br></br>- [Measuring current in Ampere Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_ampere_meter.html) |
+| November 2021 | - Updated [Measuring current in Ampere Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_ampere_meter.html)</br></br>- Editorial changes     |
+| June 2021 | Updated Pin connections in Ampere Meter mode                                                         |
+| February 2021 | - Updated [Using the Power Profiler app](using_ppk_app.md)</br></br>- Updated [Measuring current in Source Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_source_meter.html)</br></br>- Updated [Measuring current in Ampere Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_ampere_meter.html)</br></br>- Added [Views](overview.md)</br></br>- Editorial changes     |
+| December 2020 | First release                                                                                        |
diff --git a/doc/mkdocs.yml b/doc/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: nRF Connect Power Profiler documentation
+site_name: Power Profiler app documentation
 site_url:
 use_directory_urls: false
 
@@ -30,7 +30,7 @@ extra_css:
   - stylesheets/style.css
 
 copyright:
-  Copyright &copy; 2023
+  Copyright &copy; 2019-2024
 
 markdown_extensions:
   - abbr
@@ -42,9 +42,6 @@ markdown_extensions:
   - pymdownx.keys
   - pymdownx.tabbed
   - pymdownx.superfences
-  - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
   - toc:
       permalink: true
       toc_depth: 4
@@ -56,6 +53,7 @@ plugins:
 
 extra:
   test: This is a test abbreviation snippet
+  app_name: Power Profiler app
 
 nav:
   - Home: index.md

diff --git a/doc/zoomin/custom.properties b/doc/zoomin/custom.properties
@@ -1,3 +1,3 @@
 manual.name=nrf-connect-ppk
-booktitle=nRF Connect Power Profiler
-shortdesc=Documentation for the nRF Connect Power Profiler application.
+booktitle=Power Profiler app
+shortdesc=Documentation for the Power Profiler application.