Skip to content

docs(research): Android participant instructions for Research Edition sideload - #185

Merged
ErikBjare merged 2 commits into
ActivityWatch:masterfrom
TimeToBuildBob:feat/research-android-participant-instructions
Sep 17, 2026
Merged

ErikBjare merged 2 commits into
ActivityWatch:masterfrom
TimeToBuildBob:feat/research-android-participant-instructions

Conversation

@TimeToBuildBob

Copy link
Copy Markdown
Contributor

Summary

Adds src/research/participant-instructions-android.rst — participant-facing
install and export steps for the Android Research Edition APK, and wires it
into the research toctree.

Follows up on #181 (desktop guide, merged), which explicitly deferred Android:
"The VR Android pilot (direct APK, ~40 people, deadline 2026-09-29) will need
its own page before anyone sideloads; that is a follow-up, not this PR."

What the page covers:

  • Enable "Install from unknown sources" — Android 8+ per-app path, Android 7
    global path, Oculus/Meta Quest Developer Mode for VR headsets
  • Download and install the APK
  • Confirm the Research Edition badge on port 5667
  • Export via "Export all buckets as JSON" and upload
  • Researcher notes: battery optimisation exemption, export-fails-closed rule,
    two-buckets-is-normal, fixed export filename

The page is styled to match participant-instructions.rst and ends with a
cross-reference to it.

Test plan

  • sphinx-build passes without warnings on the new file
  • Toctree renders the Android page alongside the desktop page
  • Cross-reference :ref:\research-participant-instructions`` resolves
  • Researcher notes section is accurate against v0.14.0b5-research behaviour

…tion

Covers the VR pilot sideload flow: enable unknown sources, download APK,
install, confirm Research Edition badge on port 5667, export and upload.
Includes Oculus/Meta Quest Developer Mode note for VR headset installs
and researcher notes on battery optimisation and the export-fails-closed rule.

Adds the page to the research toctree alongside the desktop guide.

Git-Session-Id: 2532
@TimeToBuildBob

TimeToBuildBob commented Sep 17, 2026

Copy link
Copy Markdown
Contributor Author

🤖 AI code review

Safe to merge — no P0/P1 findings

Confidence 5/5

No findings. The diff looks correct to me on this pass.

Reviewed 4f862a80b26b · openrouter/deepseek/deepseek-v4-flash-0731 · llm (in-band) engine · 3s · about this reviewer

Maintainer commands

@TimeToBuildBob review (own line) — fresh review · @TimeToBuildBob fix — a worker acts on the findings. Once per comment; 👀 = received.

@greptile-apps

greptile-apps Bot commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

The documentation changes appear safe to merge, with both previous findings resolved and no actionable new issue established.

Summary

Adds participant-facing instructions for installing, verifying, operating, and exporting data from the Android Research Edition, and links the page from the research documentation index.

  • Covers Android and Meta Quest sideloading workflows.
  • Documents Research Edition identification, data export, battery optimization, and application-data isolation.
  • Revises export guidance to handle both save prompts and silent browser downloads.
  • Clarifies that standard and Research installations have separate storage while imported data can still enter the Research database.

Reviews (2) · Last reviewed commit: "docs(research): clarify Android export s..."

Comment thread src/research/participant-instructions-android.rst Outdated
Comment thread src/research/participant-instructions-android.rst Outdated
Address Greptile review on ActivityWatch#185:

- Export step: document that Android may save the file directly to
  Downloads instead of showing a chooser, and where to find it.
- Researcher notes: the Research Edition has its own app ID and data
  directory (verified side-by-side install), so an existing standard
  ActivityWatch database is not the trigger for export refusal. The
  reachable path is an import/restore into the Research app, and the
  Android build does not implement the desktop export guard.
- Rename the Android notes heading to avoid the duplicate autosectionlabel
  warning against the desktop page.

Git-Session-Id: 7c5a6e57-2df4-5e17-acc2-1959b0d3f7ab
@TimeToBuildBob

Copy link
Copy Markdown
Contributor Author

@greptileai review

@ErikBjare
ErikBjare merged commit 7e5d703 into ActivityWatch:master Sep 17, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants