Skip to main content

RADAR-base Documentation

AlphaThis documentation site is a work in progress — pages and components are still being added.

Documentation for every RADAR-base component, published straight from the repository that owns it and versioned with its releases.

Platform overview

Components

One section per RADAR-base repository, published from that repository and versioned with its releases.

Client documentation

The apps and devices a study runs on: what they collect, which hardware is supported, and how participants are connected to third-party wearable accounts.

Participant documentation

Material written for the people taking part in a study, to hand out or adapt for your own.

Questions and common issues

The FAQ and common issues page collects the places where RADAR-base questions are answered — GitHub Discussions for the components that use them, and each component's issue tracker — along with the problems people hit most often while the platform is being set up.

Adding your repository

Add a docs/ folder to your repository and list the repository in repos.yml on this site. Your documentation is picked up on the next build, and a new version is published every time you tag a release. To control page order, grouping and titles, add a docs/radar-docs.yml manifest to your repository — it stays under your control, alongside your code.