README.md

Note

This repository has been archived, because it is considered feature-complete. ✔️

nRF Asset Tracker documentation

The nRF Asset Tracker aims to provide a concrete end-to-end example for an ultra-low power cellular IoT product in the asset tracker space.

Read the complete nRF Asset Tracker documentation.

Building the docs locally

Build the Docker image:

docker build -t nordicsemiconductor/asset-tracker-cloud-docs/builder ./

Then build the docs:

make html

The result will be placed in ./build/html.

You can use node-static to serve it from this folder:

npx node-static build/html

Extending the documentation

The documentation is written in reStructuredText, following the nRF Connect SDK guidelines.

Publishing the documentation

This documentation is built using Sphinx, and is available for the saga branch and for the major nRF Connect SDK release versions in sub-directories in the gh-pages branch of this repository.

A deployment is triggered by pushing commits to the respective branch and is automated using GitHub actions. See ./github/workflows/test-and-release.yaml.