Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kim Scott committed Nov 7, 2020
1 parent fe7e035 commit c0b8624
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
3 changes: 1 addition & 2 deletions app/components/exp-lookit-start-recording/doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ Dedicated frame to start session recording.

This frame will take a few seconds to get a session-level recording started, then proceed
immediately to the next frame. (See
`Lookit docs <https://lookit.readthedocs.io/en/develop/researchers-create-experiment.html?highlight=startSessionRecording#recording-webcam-video>`__
for information about session-level vs. individual-frame recording.)
:ref:`Lookit docs <recording-video>` for information about session-level vs. individual-frame recording.)

(You could also set startSessionRecording to true on any frame, but then you need to rely
on that individual frame's setup for waiting for recording before getting started.)
Expand Down
2 changes: 1 addition & 1 deletion app/components/exp-lookit-stop-recording/doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Dedicated frame to stop session recording.

This frame will take a few seconds to upload an ongoing session-level recording, then proceed
immediately to the next frame. (See
`Lookit docs <https://lookit.readthedocs.io/en/develop/researchers-create-experiment.html?highlight=startSessionRecording#recording-webcam-video>`__
:ref:`Lookit docs <recording-video>`
for information about session-level vs. individual-frame recording.)

It will time out after a default of 5 minutes of waiting for the upload to complete, or
Expand Down
6 changes: 3 additions & 3 deletions app/mixins/expand-assets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,13 +187,13 @@ The Lookit stimuli template on Github
One option for hosting your stimuli is to put them in a GitHub repo which has the directory structure described above
already built-in. You can make your own copy by following the directions at `Lookit stimuli template repo <https://github.com/lookit/lookit-stimuli-template>`__.
This is best for smallish stimuli (not for long video files >10MB). For a discussion of other options for hosting your
files, see `the main Lookit docs <https://lookit.readthedocs.io/en/develop/researchers-prep-stimuli.html#putting-your-stimuli-files-online>`__.
files, see :ref:`the main Lookit docs <docs:putting-stimuli-online>`.

Troubleshooting
~~~~~~~~~~~~~~~~

If media files aren't displaying as expected, the most important thing to do is to `check the browser console for
relevant error messages <https://lookit.readthedocs.io/en/develop/tutorial-first-study.html#using-the-javascript-console-in-your-browser-to-learn-more-about-any-problems>`__.
If media files aren't displaying as expected, the most important thing to do is to :ref:`check the browser console for
relevant error messages <docs:browser-console>`.
Generally you will see a 404 error saying that a file wasn't found, so you can check where the
experiment runner is *looking* for the file to understand if there's a discrepancy between that and where you have it.

Expand Down

0 comments on commit c0b8624

Please sign in to comment.