jspsych-builder icon indicating copy to clipboard operation
jspsych-builder copied to clipboard

Expanding docs (largely in the form of examples)

Open jmuchovej opened this issue 3 years ago • 3 comments

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.)

jmuchovej avatar Mar 04 '22 14:03 jmuchovej

Contributions are most welcome!

bjoluc avatar Mar 06 '22 15:03 bjoluc

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

jmuchovej avatar Mar 06 '22 19:03 jmuchovej

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

bjoluc avatar Mar 06 '22 20:03 bjoluc