Skip to content

Commit c908509

Browse files
divipillaisimensrostad
authored andcommitted
doc: doc publish on PR merge
Updated the workflow to publish doc on every PR merge and minor doc fixes. Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
1 parent 1e673a9 commit c908509

File tree

5 files changed

+27
-16
lines changed

5 files changed

+27
-16
lines changed

.github/workflows/zoomin-publish.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
name: Publish documentation to Zoomin prod
22

33
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
paths:
11+
- docs
412
workflow_dispatch:
13+
push:
14+
branches:
15+
- main
516

617
jobs:
718
create-zoomin-bundle:

docs/common/location_services.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ The Asset Tracker uses [nRF Cloud's location services](https://docs.nordicsemi.c
66

77
The following location methods are supported:
88

9-
* **GNSS (Global Navigation Satellite System)**
9+
* **GNSS (Global Navigation Satellite System):**
1010

11-
- Highest accuracy positioning.
12-
- Best suited for outdoor use.
13-
- Higher power consumption compared to other methods.
11+
- Highest accuracy positioning.
12+
- Best suited for outdoor use.
13+
- Higher power consumption compared to other methods.
1414

15-
* **Cellular**
15+
* **Cellular:**
1616

17-
- Uses cellular tower information for positioning.
18-
- Works indoors.
19-
- Lower power consumption than GNSS.
17+
- Uses cellular tower information for positioning.
18+
- Works indoors.
19+
- Lower power consumption than GNSS.
2020

21-
* **Wi-Fi**
21+
* **Wi-Fi:**
2222

23-
- Uses nearby Wi-Fi access points for positioning.
24-
- Excellent for indoor positioning.
25-
- Lower power consumption than GNSS.
23+
- Uses nearby Wi-Fi access points for positioning.
24+
- Excellent for indoor positioning.
25+
- Lower power consumption than GNSS.
2626

2727
## Integration with nRF Cloud
2828

docs/modules/environmental.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,6 @@ The Environmental module can be configured using the following Kconfig options:
5454

5555
For more details on Kconfig options, see the `Kconfig.environmental` file in the module's directory.
5656

57-
## State
57+
## State machine
5858

5959
The environmental module implements a very simple state machine with only one state, `STATE_RUNNING`.

docs/modules/location.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,6 @@ Several Kconfig options in `Kconfig.location` control this module's behavior. Th
7575

7676
For more details on these configurations, refer to `Kconfig.location`.
7777

78-
## State diagram
78+
## State machine
7979

80-
The following is a representation of the state machine implemented in `location.c`. The module uses a single state (**STATE_RUNNING**) with an entry function (`location_init()`) that initializes the location library and a run function that processes incoming messages.
80+
The state machine implemented in `location.c`. The module uses a single state (**STATE_RUNNING**) with an entry function (`location_init()`) that initializes the location library and a run function that processes incoming messages.

docs/modules/power.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ See the `Kconfig.power` file in the module's directory for more details on the a
5757
- The Power module uses `npm1300_charger` as specified by device tree.
5858
- The two UART devices `uart0_dev` and `uart1_dev` defined in device tree will be enabled or disabled based on VBUS events.
5959

60-
## State diagram
60+
## State machine
6161

6262
The Power module uses a minimal state machine with a single state, **STATE_RUNNING**. In this state, the module:
6363

0 commit comments

Comments
 (0)