-
Notifications
You must be signed in to change notification settings - Fork 371
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add jsPsych docs #371
Comments
@mekline Just checking that you're ok with changing the terminology/labels in the docs so that "CHS" refers to the site and "Lookit" refers to the EFP experiment runner. See screenshot below for examples. I need to differentiate the EFP and jsPsych experiment runners in the docs somehow. IIRC from the Lookit-CHS merge, we're now referring to EFP as "Lookit", but the docs are still using "Lookit" to refer to the site in several places. So I'd like to change those references to "CHS" and use "Lookit" specifically for EFP. |
@mekline another quick question: while going through the docs, should I replace the lookit at mit email with the CHS gmail one? |
@mekline another question about this issue! I have a separate PR that updates the theme and edits the tabs above the navigation menu to include a tab for the CHS jsPsych docs. Here's a draft of my changes: And here's what the site currently looks like, for reference: Changes to note:
I can also add/change the icon images next to the project name and in the tabs. The EFP puzzle piece icon comes from font-awesome, and they have lots of other icons that are super easy to import: https://fontawesome.com/search. We could also use the CHS logo somewhere, and maybe the jsPsych logo (with permission!)? What do you think? Once we decide on how this will look, I can update the EFP and jsPsych docs so that their menu looks the same (i.e. this issue: #435). |
We need to add information about the jsPsych study type to the Lookit docs. This should correspond to the initial release of jsPsych study types on production, and will require new pages/sections. It should include all the basic information needed to set up a jsPsych experiment: what to put in the study details box (JS only, no HTML), and limitations on CHS-jsPsych studies (available plugins, loading custom plugins/css etc.). The docs should focus on things related to running jsPsych experiments on CHS specifically, and should direct people to the jsPsych docs/examples as much as possible (rather than duplicating existing documentation on how to use jsPsych).
See this issue for more details on what should go in the docs for the first MVP: lookit/lookit-api#1324
After the jsPsych docs are live, we may need to replace any placeholder links in the lookit-api with the real link (e.g. in the
JSPsychForm
help text).While we're editing the docs on the study create/edit forms, if it's not too much extra work, we might also consider updating the other outdated parts of the docs/screenshots in these sections (for instance, study create/edit used to be one large form but has since been split into two: #322, #327).
The text was updated successfully, but these errors were encountered: