feat: Add documentation for the new directory structure #103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was
linked to
issues
Feb 26, 2024
|
This is going to be a massive comment 😬 |
tdivoll
approved these changes
Feb 28, 2024
| @@ -38,149 +38,184 @@ This folder contains different files used to pass environment variables (setting | |||
| ## node_modules/ | |||
|
|
|||
| :::danger | |||
| `node_modules/` is written to when running `npm install` and should never be manually edited. | |||
| `node_modules/` is written to when running `npm install` and should never be edited. It is in Honeycomb's `.gitignore` and should never be added to git. | |||
| ::: | |||
|
|
|||
| ## psiturkit/ | |||
|
|
|||
| The file `psiturk-it` inside `psiturkit/` is a bash script used to instal PsiTurk locally - see [PsiTurk](psiturk#build-instructions) for more information. | |||
There was a problem hiding this comment.
Should you add the extension to this psiturk-it file to better distinguish between the file and the directory?
There was a problem hiding this comment.
Eh, I'm not to worried about it. Nobody really uses psiturk anymore and it's going to be deprecated in v4
Co-authored-by: Timothy Divoll <[email protected]>
Co-authored-by: Timothy Divoll <[email protected]>
Co-authored-by: Timothy Divoll <[email protected]>
Co-authored-by: Timothy Divoll <[email protected]>
Co-authored-by: Timothy Divoll <[email protected]>
Co-authored-by: Timothy Divoll <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
src/experiment/folderindex.jsandhoneycomb.jsexperiment/procedures/experiment/trials/honeycomb_.js files are for the example experiment and that the user should create their experiment in new files