search

bjoluc / jspsych-builder

A CLI utility to easily develop and package jsPsych experiments
MIT License
46 stars 12 forks source link

Expanding docs (largely in the form of examples) #20

Open jmuchovej opened 2 years ago

jmuchovej commented 2 years ago

Maybe this doesn't belong as an issue (but discussions are disabled 😉)...

I totally understand how "small" this project is, at the moment, so I'm curious if that largely "explains" the minimal examples (e.g., demonstrating how to use React with this, demonstrating how one could further customize the run(...) function, potentially demonstrating how to integrate React with jsPsych, etc.)

Certainly not on you, especially since each of those MWEs is a fair bit of work to build a self-contained example. 😅 (This is something I'm down to contribute to, as I've sorted out how to do most of these examples, albeit in probably a mostly toy-like capacity.)

bjoluc commented 2 years ago

Contributions are most welcome!

jmuchovej commented 2 years ago

How should these be structured? Do they belong in an examples/ directory or maybe under docs/?

bjoluc commented 2 years ago

I think examples/ makes a lot of sense with per-project docs in a readme.md or so.