Skip to content

Commit f801d31

Browse files
greg-fergreg-fer
authored
Merge pull request #916 from greg-fer/doc_migrate_docs_to_mkdocs_and_zoomin
doc: add mkdocs and zooming framework files
2 parents f874d44 + 691dd0b commit f801d31

16 files changed

+238
-1
lines changed

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Publish documentation to Zoomin
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- docs
9+
workflow_dispatch:
10+
11+
jobs:
12+
create-zoomin-bundle:
13+
name: Create Zoomin bundle
14+
uses: './.github/workflows/zoomin.yml'
15+
publish-zoomin-bundle:
16+
name: Publish Zoomin bundle to dev
17+
needs: create-zoomin-bundle
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Get bundle
21+
uses: actions/download-artifact@v3
22+
with:
23+
name: nrf-connect-desktop
24+
- name: Upload documentation
25+
run: |
26+
# trust server
27+
mkdir -p ~/.ssh
28+
ssh-keyscan upload-v1.zoominsoftware.io >> ~/.ssh/known_hosts
29+
30+
# prepare key
31+
echo "${{ secrets.ZOOMIN_KEY }}" > zoomin_key
32+
chmod 600 zoomin_key
33+
34+
# upload bundle:
35+
sftp -v -i zoomin_key [email protected] <<EOF
36+
cd /nordic-be-dev.zoominsoftware.io/markdown/incoming
37+
put nrf-connect-desktop.zip
38+
quit
39+
EOF

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Publish documentation to Zoomin
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
create-zoomin-bundle:
8+
name: Create Zoomin bundle
9+
uses: './.github/workflows/zoomin.yml'
10+
publish-zoomin-bundle:
11+
name: Publish Zoomin bundle
12+
needs: create-zoomin-bundle
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Get bundle
16+
uses: actions/download-artifact@v3
17+
with:
18+
name: nrf-connect-desktop
19+
- name: Upload documentation
20+
run: |
21+
# trust server
22+
mkdir -p ~/.ssh
23+
ssh-keyscan upload-v1.zoominsoftware.io >> ~/.ssh/known_hosts
24+
25+
# prepare key
26+
echo "${{ secrets.ZOOMIN_KEY }}" > zoomin_key
27+
chmod 600 zoomin_key
28+
29+
# upload bundle:
30+
sftp -v -i zoomin_key [email protected] <<EOF
31+
cd /docs-be.nordicsemi.com/markdown/incoming
32+
put nrf-connect-desktop.zip
33+
quit
34+
EOF

‎.github/workflows/zoomin.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Create Zoomin bundle
2+
3+
on:
4+
pull_request:
5+
types: [synchronize, opened, reopened]
6+
paths:
7+
- '.github/workflows/zoomin.yml'
8+
workflow_dispatch:
9+
workflow_call:
10+
11+
jobs:
12+
create-zoomin-bundle:
13+
name: Create Zoomin bundle
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
18+
- name: Copy zoomin properties
19+
run: cp doc/docs/zoomin/* .
20+
21+
- name: Replace index.md
22+
run: cp doc/docs/zoomin/index.md doc/docs/index.md
23+
24+
- name: Create zip file
25+
run: |
26+
zip -r nrf-connect-desktop.zip \
27+
docs mkdocs.yml custom.properties tags.yml \
28+
-x@docs/zoomin/ignore.txt
29+
30+
- name: Upload documentation artifact
31+
uses: actions/upload-artifact@v3
32+
with:
33+
name: nrf-connect-desktop
34+
path: nrf-connect-desktop.zip
35+
retention-days: 7

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Nordic Semiconductor are:
7070
### Proxy settings
7171

7272
To use behind a proxy, see
73-
[proxy settings](https://github.com/NordicSemiconductor/pc-nrfconnect-launcher/blob/main/doc/proxy-settings.md).
73+
[proxy settings](https://github.com/NordicSemiconductor/pc-nrfconnect-launcher/blob/main/doc/non-mkdocs/proxy-settings.md).
7474

7575
## Developing
7676

‎doc/custom.properties‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
manual.name=nrf-connect-desktop
2+
booktitle=nRF Connect for Desktop
3+
shortdesc=Documentation for the nRF Connect for Desktop launcher application.

‎doc/docs/index.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# nRF Connect for Desktop launcher
2+
3+
nRF Connect for Desktop is a cross-platform framework for development applications. It contains applications for testing Bluetooth® Low Energy, monitoring LTE links, power optimization, programming, and more.
4+
5+
## Supported operating systems
6+
7+
nRF Connect for Desktop has Tier 1 support for the following platforms:
8+
9+
* Ubuntu 20.04 LTS (x64)
10+
* Windows 10 (x64)
11+
* MacOS 11 (x64, arm64)
12+
13+
In addition, nRF Connect for Desktop has Tier 2 support for Windows 11 (x64), Ubuntu 22.04 (x64), and MacOS 12 (x64, arm64).
14+
15+
??? info "Tier definitions"
16+
**Tier 1**: The tools will always work. The automated build and automated testing ensure that the tools build and successfully complete tests after each change.
17+
18+
**Tier 2**: The tools will always build. The automated build ensures that the tools build successfully after each change. There is no guarantee that a build will work because the automation tests do not always run.
19+
20+
**Tier 3**: The tools are supported by design, but are not built or tested after each change. Therefore, the application may or may not work.
21+
22+
**Not supported**: The tools do not work, but it may be supported in the future.
23+
24+
**Not applicable**: The specified architecture is not supported for the respective operating system.
25+
26+
27+
## Download
28+
29+
You can download nRF Connect for Desktop from Nordic Semiconductor's [website](https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Connect-for-desktop).
30+
31+
!!! note
32+
On macOS and Linux, you must download and install the [SEGGER J-Link Software](https://www.segger.com/downloads/jlink/#J-LinkSoftwareAndDocumentationPack) separately.
33+
34+
After installing and starting the main application, you see an overview of available apps. Click the arrow down button to display additional information about each app.
35+
36+
## Installation of nRF Connect for Desktop applications
37+
38+
To install any of the available applications, complete the following steps:
39+
40+
1. Open nRF Connect for Desktop.
41+
2. Find the app that you want to use in the list and click **Install**.
42+
43+
Once the application is installed, you can launch it by clicking **Open**.
44+
45+
For easy access, you can create a desktop shortcut by clicking the arrow down button and selecting **Create Shortcut**.
46+
47+
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.
48+
49+
To uninstall any of the applications, click the arrow down button and select **Uninstall**.
50+
51+
!!! note
52+
Installation of nRF Connect for Bluetooth Low Energy version 4.0.0 and later differs, refer to the user guide for more information.
53+
54+
!!! note
55+
If you experience unexpected behavior, press Ctrl+R to refresh any of the nRF Connect for Desktop apps that are open.

‎doc/mkdocs.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
site_name: nRF Connect for Desktop launcher documentation
2+
site_url:
3+
use_directory_urls: false
4+
5+
theme:
6+
name: material
7+
palette:
8+
- scheme: custom-blue
9+
toggle:
10+
icon: material/lightbulb-outline
11+
name: Switch to dark mode
12+
- scheme: custom-blue-dark
13+
toggle:
14+
icon: material/lightbulb
15+
name: Switch to light mode
16+
# logo: assets/logo.png
17+
# favicon: assets/logo.png
18+
features:
19+
- content.code.annotate
20+
- content.tooltips
21+
- content.tabs.link
22+
- navigation.indexes
23+
- navigation.top
24+
- navigation.tracking
25+
- search.highlight
26+
- toc.follow
27+
28+
29+
extra_css:
30+
- stylesheets/style.css
31+
32+
copyright:
33+
Copyright &copy; 2023
34+
35+
markdown_extensions:
36+
- abbr
37+
- admonition
38+
- attr_list
39+
- md_in_html
40+
- meta
41+
- pymdownx.details
42+
- pymdownx.keys
43+
- pymdownx.tabbed
44+
- pymdownx.superfences
45+
- pymdownx.emoji:
46+
emoji_index: !!python/name:materialx.emoji.twemoji
47+
emoji_generator: !!python/name:materialx.emoji.to_svg
48+
- toc:
49+
permalink: true
50+
toc_depth: 4
51+
52+
plugins:
53+
- macros
54+
- search
55+
56+
57+
extra:
58+
test: This is a test abbreviation snippet
59+
60+
nav:
61+
- Home: index.md

‎doc/proxy-login-dialog.png‎ renamed to ‎doc/non_mkdocs/proxy-login-dialog.png‎

File renamed without changes.

‎doc/proxy-settings.md‎ renamed to ‎doc/non_mkdocs/proxy-settings.md‎

File renamed without changes.

‎doc/repeated-usb-address-troubleshoot.md‎ renamed to ‎doc/non_mkdocs/repeated-usb-address-troubleshoot.md‎

File renamed without changes.

0 commit comments

Comments
 (0)