Skip to content
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

Update CHS/Lookit terms and add jsPsych experiment runner #437

Merged
merged 23 commits into from
Nov 8, 2024

Conversation

becky-gilbert
Copy link
Contributor

@becky-gilbert becky-gilbert commented Nov 7, 2024

This PR does the following:

  • Updates the language so that "Children Helping Science/CHS" refers to the platform/site, and "Lookit" only refers to the EFP experiment runner.
  • Adds the jsPsych study type and experiment runner option. (The CHS jsPsych documentation is still pretty minimal, but I made changes throughout the site to mention that it exists).
  • Updates the architecture page to include the lookit-jspsych repo.
  • Restructured the Tutorial section so that there's a single "Create a study" step with nested options: either Lookit or jsPsych. The other tutorial steps are relevant to both internal experiment runners.
  • Adds a very basic Hello World CHS-jsPsych tutorial for the jsPsych option in the "Create a study" step in the main tutorial.
  • Moves the study "design" fields (i.e. the fields that are specific to the study type) out of the study "details" (ad) page and into their own page. This was a hang-over from when these fields used to be all in the same form, regardless of study type, and now they're split into two separate forms.
  • Updates URLs from our old production and staging sites (mit.edu) to new domains.
  • Updates our contact email from lookit at mit.edu to CHS at gmail.

To do:

I still need to make separate PRs with the following:

  • Update the docs theme to include "tabs" (or other horizontally-placed links) at the top of the Table of Contents / Navigation, which will contain links to the EFP docs ("Lookit EFP") and the lookit-jspsych docs ("jsPsych"). Update RTD theme and add jsPsych tab #439
  • Add the same tabs to the EFP and lookit-jspsych docs (these PRs will be in those two repositories).
  • Add a "jsPsych studies" section in the docs navigation (analogous to the "Lookit studies" section), with a few pages about the CHS jsPsych experiment runner, links to jsPsych docs and our docs/tutorial, limitations (e.g. list the set of packages/versions that are available), release notes. Add jspsych studies section #438
  • Replace the static lookit-jspsych docs links with intersphinx mapping links.

… details/design pages, move study design fields from study details page, add jsPsych info
…o all study types, add new study design page
…sign page) and add study type section with jsPsych option
…o Study Ad/Design, add Design options for jsPsych and external
Comment on lines 4 to 12
What is the name of this platform? Children Helping Science or Lookit?
---------------------------------------------------------------------------

Children Helping Science (CHS) is the name of the website, and Lookit is the name of the 'default' experiment runner.

The whole platform was called Lookit when it was first created. In May 2023, it merged with a separate-but-similar project called Children Helping Science. Now, the platform (website) is called Children Helping Science (CHS), and the internal experiment runner is called Lookit. So if you're used to using the "Lookit" name for the whole site, you'll still see that term used to refer to a specific study type, i.e. studies that use the ember-lookit-frameplayer. You'll also see some remnants of the previous naming system in, for instance, the names of our open-source code repositories - the codebase for the CHS website is "lookit-api" and the CHS documentation is "lookit-docs".

What is the name of the internal experiment runner? LoOkIt, Look!t, LooKit?
--------------------------------------------------------------------------------------
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mekline new FAQ section about CHS vs Lookit.

subtle changes to Lookit/CHS nomenclature
Updating some nomenclature information - Becky, can you please check for any link display issues?
Copy link
Collaborator

@mekline mekline left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready to go! Epic, nice job :)

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.

Add jsPsych docs
3 participants