doc: add documentation framework and basic docs

Added documentation framework files.
Added basic docs.
NCD-684.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

.github/workflows/zoomin-publish-dev.yml

@@ -0,0 +1,39 @@
+name: Publish documentation to Zoomin dev
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - doc/docs
+  workflow_dispatch:
+
+jobs:
+  create-zoomin-bundle:
+    name: Create Zoomin bundle
+    uses: './.github/workflows/zoomin.yml'
+  publish-zoomin-bundle:
+    name: Publish Zoomin bundle to dev
+    needs: create-zoomin-bundle
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get bundle
+        uses: actions/download-artifact@v3
+        with:
+          name: nrf-connect-npm
+      - name: Upload documentation
+        run: |
+          # trust server
+          mkdir -p ~/.ssh
+          ssh-keyscan upload-v1.zoominsoftware.io >> ~/.ssh/known_hosts
+
+          # prepare key
+          echo "${{ secrets.ZOOMIN_KEY }}" > zoomin_key
+          chmod 600 zoomin_key
+
+          # upload bundle:
+          sftp -v -i zoomin_key nordic@upload-v1.zoominsoftware.io <<EOF
+          cd /nordic-be-dev.zoominsoftware.io/markdown/incoming
+          put nrf-connect-npm.zip
+          quit
+          EOF

.github/workflows/zoomin-publish.yml

@@ -0,0 +1,34 @@
+name: Publish documentation to Zoomin prod
+
+on:
+  workflow_dispatch:
+
+jobs:
+  create-zoomin-bundle:
+    name: Create Zoomin bundle
+    uses: './.github/workflows/zoomin.yml'
+  publish-zoomin-bundle:
+    name: Publish Zoomin bundle
+    needs: create-zoomin-bundle
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get bundle
+        uses: actions/download-artifact@v3
+        with:
+          name: nrf-connect-npm
+      - name: Upload documentation
+        run: |
+          # trust server
+          mkdir -p ~/.ssh
+          ssh-keyscan upload-v1.zoominsoftware.io >> ~/.ssh/known_hosts
+
+          # prepare key
+          echo "${{ secrets.ZOOMIN_KEY }}" > zoomin_key
+          chmod 600 zoomin_key
+
+          # upload bundle:
+          sftp -v -i zoomin_key nordic@upload-v1.zoominsoftware.io <<EOF
+          cd /docs-be.nordicsemi.com/markdown/incoming
+          put nrf-connect-npm.zip
+          quit
+          EOF

.github/workflows/zoomin.yml

@@ -0,0 +1,34 @@
+name: Create Zoomin bundle
+
+on:
+  pull_request:
+    types: [synchronize, opened, reopened]
+    paths:
+      - '.github/workflows/zoomin.yml'
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  create-zoomin-bundle:
+    name: Create Zoomin bundle
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Copy zoomin properties
+        run: |
+          cp doc/zoomin/custom.properties doc/ \
+          && cp doc/zoomin/tags.yml doc/
+
+      - name: Create zip file
+        run: |
+          cd doc/ \
+          && zip -r ../nrf-connect-npm.zip \
+          docs/* mkdocs.yml custom.properties tags.yml
+
+      - name: Upload documentation artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: nrf-connect-npm
+          path: nrf-connect-npm.zip
+          retention-days: 7

README.md

@@ -1,21 +1,31 @@
-# nPM PowerUP
+# nRF Connect nPM PowerUP
 
 [![Build Status](https://dev.azure.com/NordicSemiconductor/Wayland/_apis/build/status/NordicPlayground.pc-nrfconnect-npm?branchName=main)](https://dev.azure.com/NordicSemiconductor/Wayland/_build/results?buildId=56483&view=results)
 [![License](https://img.shields.io/badge/license-Modified%20BSD%20License-blue.svg)](LICENSE)
 
 nRF Connect nPM PowerUP is a desktop application intended to work with the
 nPM1300 EK to allow customers to quickly and efficiently evaluate the nPM1300
-PMIC for their projects. Once connected to an EK, the app gives full control
+PMIC for their projects.
+
+Once connected to an EK, the app gives full control
 over the adjustable settings of the nPM1300 PMIC. Using the included battery
 models, you can also get an estimated time-to-full and time-to-empty when
 charging or discharging a battery connected to the EK.
 
 ## Installation
 
-nPM PowerUP is installed from nRF Connect for Desktop. For detailed steps, see
+nPM PowerUP is installed from nRF Connect for 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 nPM PowerUP](https://docs.nordicsemi.com/bundle/nrf-connect-npm/page/index.html)
+official documentation, which includes information about the
+[application UI](https://docs.nordicsemi.com/bundle/nrf-connect-npm/page/overview.html).
+
 ## Development
 
 See the

doc/docs/index.md

@@ -0,0 +1,15 @@
+# nRF Connect nPM PowerUP
+
+nRF Connect nPM PowerUP is a desktop application intended to work with the Power Management Integrated Circuit (PMIC) devices from Nordic Semiconductor to allow customers to quickly and efficiently evaluate the PMIC for their projects.
+
+Once connected to an Evaluation Kit (EK), the app gives full control over the adjustable settings of the PMIC. Using the included battery models, you can also get an estimated time-to-full and time-to-empty when
+charging or discharging a battery connected to the EK.
+
+nPM PowerUP is installed and updated using [nRF Connect for Desktop](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/index.html).
+
+## Supported devices
+
+nPM PowerUP supports the following Power Management IC devices from Nordic Semiconductor:
+
+- nPM1300 EK - Read [Connect the nPM1300 EK with nPM PowerUP](https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/use_ek_power_up.html) for information about the hardware setup required to use the nPM1300 EK with nPM PowerUP.
+- nPM1300 Fuel Gauge Board - Read [](https://docs.nordicsemi.com/bundle/nan_045/page/APP/nan_045/battery_profiling.html) for information about the hardware setup required to use the nPM1300 Fuel Gauge Board together with nPM1300 EK and nPM PowerUP.

doc/docs/installing.md

@@ -0,0 +1,3 @@
+# Installing nPM PowerUP app
+
+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.

doc/docs/overview.md

@@ -0,0 +1,103 @@
+# Overview and user interface
+
+After starting nPM PowerUP, the main application window is displayed.
+
+![nPM PowerUP application window](./screenshots/npm_overview.png "nPM PowerUP application window")
+
+The available options and information change after you **Select Device**.
+
+!!! info "tip"
+      This page provides only a general overview of the application UI. For detailed information about each option, see its tooltip.
+
+       ![Example of a tooltip in nPM PowerUP](./screenshots/npm_tooltip_example.png "Example of a tooltip in nPM PowerUP")
+
+## Before selection
+
+Before a device is selected, the side panel contains the following buttons:
+
+### Select Device
+
+Dropdown to list the PMIC devices attached to the computer.
+
+!!! note "Note"
+      Read [Connect the nPM1300 EK with nPM PowerUP](https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/use_ek_power_up.html) for information about the hardware setup required to use the nPM1300 EK with nPM PowerUP.
+
+## After selection
+
+When a device is selected, the side panel options become available.
+
+![](./screenshots/ "")
+
+### Actions
+
+This side panel area contains the following buttons:
+
+|          Button          | Purpose |
+| ------------------------ | ------- |
+| **Export Configuration** | Purpose |
+| **Load Configuration**   | Purpose |
+| **Open Serial Terminal** | Opens the [nRF Connect Serial Terminal](https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/index.html) application in a separate window. Make sure to first [install the application](). |
+| **Reset Device**         | Purpose |
+| **Record Events**        | Purpose |
+
+### Fuel Gauge
+
+This side panel area lets you select the following options:
+
+- **Active Battery Model** -
+- **Add New Active Battery Model** -
+
+### Settings
+
+This side panel area lets you configure the reporting rate.
+
+### Connection Status
+
+## Dashboard tab
+
+The **Dashboard** tab provides a quick look overview of the major PMIC settings from the **Charger** and **Regulators** tabs.
+
+## Charger tab
+
+You can use the options in the **Charger** tab to control and monitor the charging settings and status of the PMIC device.
+
+Using the built-in battery models, you can get an estimated time-to-full and time-to-empty when charging or discharging a battery connected to the EK.
+
+## Regulators tab
+
+You can use the options in the **Regulatros** tab to enable or disable specific voltage regulators (like **BUCK** or **LDO**).
+
+Here you can also set the output and retention voltage for each regulator and monitor its status.
+
+## GPIOs tab
+
+You can use the options in the **GPIOs** tab to configure the GPIO pins available on the PMIC device.
+
+## System Features tab
+
+You can use the options in the **System Features** tab to configure the **Reset and Low Power control**, **Timer**, **Power Failure**, **Vbus input current limiter**, and **Reset & Error Logs**.
+
+## Profiles tab
+
+To make changes to the generated battery model, upload the projects in the PROFILES tab of the nPM PowerUP app. You can then make edits, merge individual temperature profiles, or change the configuration settings of the generated battery model.
+Note: The battery model is automatically stored as .json and .inc file formats. Use the .json file for evaluations in nPM PowerUP and the .inc file when integrating the battery model to your final application with a Nordic System on Chip (SoC). Refer also to nPM1300 fuel gauge application samples.
+
+
+## Graph tab
+
+After generating the battery model, you can use the GRAPH tab in the nPM PowerUP app to evaluate the battery state-of-charge predictions in real time. Make sure the battery fuel gauge on the DASHBOARD tab is enabled.
+
+![nPM PowerUP graph example](./screenshots/npm_graph_example.png "nPM PowerUP graph example")
+
+## Log
+
+The Log panel allows you to view the most important log events, tagged with a timestamp. Each time you open the app, a new session log file is created. You can find the Log panel and its controls, below the main application Window.
+
+- When troubleshooting, to view more detailed information than shown in the Log panel, use **Open log file** to open the current log file in a text editor.
+- To clear the information currently displayed in the Log panel, use **Clear Log**. The contents of the log file are not affected.
+- To hide or display the Log panel in the user interface, use **Show Log**.
+- To freeze Log panel scrolling, use **Autoscroll Log**.
+
+## 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, send feedback, and enable verbose logging.

doc/mkdocs.yml

@@ -0,0 +1,63 @@
+site_name: nRF Connect nPM PowerUP documentation
+site_url:
+use_directory_urls: false
+
+theme:
+  name: material
+  palette:
+    - scheme: custom-blue
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to dark mode
+    - scheme: custom-blue-dark
+      toggle:
+        icon: material/lightbulb
+        name: Switch to light mode
+  # logo: assets/logo.png
+  # favicon: assets/logo.png
+  features:
+    - content.code.annotate
+    - content.tooltips
+    - content.tabs.link
+    - navigation.indexes
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - toc.follow
+
+
+extra_css:
+  - stylesheets/style.css
+
+copyright:
+  Copyright © 2023
+
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - md_in_html
+  - meta
+  - pymdownx.details
+  - 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
+
+plugins:
+  - macros
+  - search
+
+
+extra:
+  test: This is a test abbreviation snippet
+
+nav:
+  - Home: index.md
+  - Installing nPM PowerUP app: installing.md
+  - Overview and user interface: overview.md

doc/zoomin/custom.properties

@@ -0,0 +1,3 @@
+manual.name=nrf-connect-npm
+booktitle=nRF Connect nPM PowerUP
+shortdesc=Documentation for the nRF Connect nPM PowerUP application.

doc/zoomin/tags.yml

@@ -0,0 +1,10 @@
+# Document tags for Zoomin.
+
+# Tags for all topics:
+mapping_global:
+  - nrf-connect-npm
+
+# Tags for individual topics:
+#mapping_topics:
+#  - filename.md: ["tag1","tag2"]
+