docs(research): add Research Edition page for researchers - #186
Conversation
|
Scope the no-titles/URLs claim to aw-watcher-window and warn that extra watchers can still store URLs. Distinguish the browser category map from the optional research_app_category_map, which is what actually hides unmapped app names. Git-Session-Id: fd976f58-24ed-5526-8cd7-235d83bc0a3d
|
@greptileai review |
The 1-5 MB per participant-week figure had no measurement. Extra watchers also grow the JSON export, so a published range would mislead storage and upload planning. Point studies at a pilot-week measurement instead. Git-Session-Id: 24cde253-57d2-5213-b103-f7669205f12d
🤖 AI code reviewSafe to merge — no P0/P1 findingsConfidence 5/5 ✅ No findings. The diff looks correct to me on this pass. Previous review passes
Reviewed Maintainer commands
|
|
@greptileai review |
A sibling restore put the unmeasured 1-5 MB figure back. Greptile's P2 is that researchers must not plan storage around an unpublished measurement. Keep the extra-watcher caveat and the pilot-week measurement guidance. Git-Session-Id: 24cde253-57d2-5213-b103-f7669205f12d
|
@greptileai review |
Greptile P2: "mostly short category strings" understated the all-bucket JSON. Name the actual contents — filtered window events and AFK events, each with timestamp and duration, window events keeping app names and study categories — and keep the extra-watcher caveat plus the pilot-week measurement line. Git-Session-Id: d5e38c4c-8308-564d-8a10-cb3ae24c26d6
|
@greptileai review |
| has a timestamp and duration; window events keep the application name and the | ||
| study category, with titles and URLs already dropped. Extra watchers connected |
There was a problem hiding this comment.
Non-browser categories overstated. The default export also includes non-browser window events. As the page explains above, those retain application names without a study category unless the optional app-category map is configured. Saying that window events keep both an application name and a study category could lead researchers to expect a category for every window event.
| has a timestamp and duration; window events keep the application name and the | |
| study category, with titles and URLs already dropped. Extra watchers connected | |
| has a timestamp and duration; window events keep the application name by | |
| default. Browser window events also keep the study category, with titles and | |
| URLs already dropped. Extra watchers connected |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Summary
Adds
src/research/research-edition.rst, a researcher-facing page for the Research Edition, at the top of the existing Research section toctree (the section, participant instructions and Android instructions already exist). Also fixes tworesearch/index.rstbullets that overstated things: "Category-only collection" (app names are kept in the current build) and "plus Android" (Android has no filter or release yet).Final URL once deployed: https://docs.activitywatch.net/en/latest/research/research-edition.html
Companion blog post: ActivityWatch/activitywatch.github.io#73. Merge this PR first, then the post, so its docs link does not 404.
Verified
excluded, titles/URLs dropped before storage, non-browser titles dropped, optionalresearch_app_category_map,Excludedfor unmapped apps):aw_watcher_window/research_filter.pyandconfig.py.research-participanton export; export refuses unfiltered data: existing participant instructions and b5 hostname proof.researchflavor (net.activitywatch.android.research, 5667):aw-android/mobile/build.gradle. No-researchAndroid release exists.Please double-check (Erik)
-researchrelease is published; my page says so. Confirm that is the intended wording.