Skip to content

User Guide Map

Use this page when you are outside the project and want the documentation to behave like one connected manual.

First Three Clicks

If you are new, follow this order:

  1. Quickstart
  2. Getting Started
  3. Troubleshooting

If you prefer the CLI to choose the route for you:

iints start

Choose Your Path

Goal Read first Then read Main command
See the SDK work quickly Quickstart Getting Started iints demo
Build your own starter project Quickstart Command Reference iints start --goal project --run
Run scientific benchmarks Scientific Workflow Study Analysis iints run-study
Certify data quality MDMP Quickstart MDMP Guide iints data certify
Add your own algorithms or models Command Reference Technical Reference iints plugin install
Prepare a Raspberry Pi Raspberry Pi Digital Patient Remote Deploy & Pi Connect iints edge setup
Prepare an event booth Maker Faire Pi Mode Maker Faire Pi Checklist iints makerfaire up
Understand every command Command Reference Technical Reference iints --help
Maintain the SDK Maintainer Guide Release Checklist tools/dev/sdk_check.sh quick

How The Docs Fit Together

The public docs are split by job:

  • Start pages explain the shortest route to a successful first result.
  • User guides explain one workflow at a time.
  • Edge guides explain Raspberry Pi, UNO Q, remote deploy, offline install, and long-running studies.
  • Extension commands explain local algorithm and patient-model plugins without editing SDK source.
  • Data guides explain certification, data trust, and MDMP output.
  • Reference pages explain all commands and deeper architecture.
  • Maintainer pages explain checks, release steps, and repo upkeep.

For a first-time external evaluator:

Home
  -> User Guide Map
  -> Quickstart
  -> Getting Started
  -> Command Reference
  -> Scientific Workflow or Raspberry Pi Digital Patient

For a researcher:

Scientific Workflow
  -> Study Analysis
  -> MDMP Quickstart
  -> Evidence Base
  -> Full Technical Manual

For an edge demo:

Raspberry Pi Digital Patient
  -> Remote Deploy & Pi Connect
  -> Maker Faire Pi Mode
  -> Maker Faire Pi Checklist
  -> Arduino UNO Q Setup

If You Get Lost

Run:

iints start
iints doctor --full --suggest

Then return to: