devaanand commited on
Commit
b89016c
·
1 Parent(s): 9fce59c

Guide: researcher quickstart, Slack feedback destination, lab-tier saved-run wording

Browse files
Files changed (1) hide show
  1. backend/app/guide.html +28 -4
backend/app/guide.html CHANGED
@@ -65,6 +65,26 @@ synthetic, written for this kit; no real participant data anywhere.</p>
65
  </ul>
66
  </div>
67
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
68
  <h2 id="samples">0. Sample datasets</h2>
69
  <p>One file per platform behavior. To test something, download the file named for it and
70
  follow its scenario below. Unless stated otherwise, select language <b>English</b> and
@@ -206,8 +226,9 @@ pages don't update.</p>
206
  <ol>
207
  <li>Sign in, upload, run: no ANONYMOUS_DATA_REMOVED warning; re-running the same corpus
208
  works (file kept).</li>
209
- <li>Saved-run cap: Step 3 card shows "N of 15 saved runs used". At the cap, new runs are
210
- refused until you delete old runs/projects (nothing is auto-deleted).</li>
 
211
  <li>Ownership: your projects are invisible to signed-out visitors and other accounts.
212
  Anonymous projects stay shared.</li>
213
  </ol>
@@ -224,8 +245,11 @@ pages don't update.</p>
224
 
225
  <h2 id="feedback">10. Found something off?</h2>
226
  <p>Anything that doesn't match what this guide says it should do - or anything confusing,
227
- slow, or missing - please note the section number and what you saw, and send it to
228
- Deva (<a href="mailto:devaanand@umass.edu">devaanand@umass.edu</a>). Screenshots welcome.</p>
 
 
 
229
 
230
  </main>
231
  <a class="top" href="#">↑ Top</a>
 
65
  </ul>
66
  </div>
67
 
68
+ <h2 id="quickstart">Quickstart: run YOUR study in 5 minutes</h2>
69
+ <ol>
70
+ <li><b>Sign in</b> (top right - Google or email+password). Lab accounts have
71
+ unlimited access.</li>
72
+ <li><b>Create a project</b> named after your study.</li>
73
+ <li><b>Upload your corpus</b> - any CSV/XLSX with one text per row. Other columns
74
+ (IDs, conditions, demographics) are fine; they pass through untouched into the
75
+ results file.</li>
76
+ <li><b>Pick your construct</b> - search the library (94 scales from the lab's
77
+ collection) or click "+ Custom construct" and paste or upload your own items.</li>
78
+ <li><b>Run.</b> Read the warnings panel first (it tells you if something about your
79
+ data is off), then check the top/bottom scoring texts - if those don't make sense
80
+ for your construct, trust that instinct and report it.</li>
81
+ <li><b>Export</b> the results CSV (your columns + per-item similarities + CCR score)
82
+ and, if you want, the Python script that reproduces the run on your own machine.</li>
83
+ </ol>
84
+ <p>The sections below are structured test scenarios with sample data - useful for
85
+ systematically stress-testing the platform, but <b>your real data is the best test we
86
+ have</b>.</p>
87
+
88
  <h2 id="samples">0. Sample datasets</h2>
89
  <p>One file per platform behavior. To test something, download the file named for it and
90
  follow its scenario below. Unless stated otherwise, select language <b>English</b> and
 
226
  <ol>
227
  <li>Sign in, upload, run: no ANONYMOUS_DATA_REMOVED warning; re-running the same corpus
228
  works (file kept).</li>
229
+ <li>Saved-run budget: the Step 3 card shows "N of M saved runs used". Lab accounts on
230
+ this dev instance are set effectively unlimited; public accounts get 15. At the cap,
231
+ new runs are refused until you delete old runs/projects (nothing is auto-deleted).</li>
232
  <li>Ownership: your projects are invisible to signed-out visitors and other accounts.
233
  Anonymous projects stay shared.</li>
234
  </ol>
 
245
 
246
  <h2 id="feedback">10. Found something off?</h2>
247
  <p>Anything that doesn't match what this guide says it should do - or anything confusing,
248
+ slow, or missing - post it in the lab's <b>#ccr Slack channel</b>: the 🐞 thread for bugs,
249
+ the 💡 thread for ideas and feature requests. One line is enough; note the section number
250
+ and what you saw; screenshots help. DMs to Deva work too, and email as a fallback
251
+ (<a href="mailto:devaanand@umass.edu">devaanand@umass.edu</a>). Nothing is too small -
252
+ "this button confused me" is exactly the kind of report we want.</p>
253
 
254
  </main>
255
  <a class="top" href="#">↑ Top</a>