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

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

Open
jmuchovej opened this issue Mar 4, 2022 · 3 comments
Open

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

jmuchovej opened this issue Mar 4, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@jmuchovej
Copy link
Contributor

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
Copy link
Owner

bjoluc commented Mar 6, 2022

Contributions are most welcome!

@bjoluc bjoluc added the documentation Improvements or additions to documentation label Mar 6, 2022
@jmuchovej
Copy link
Contributor Author

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

@bjoluc
Copy link
Owner

bjoluc commented Mar 6, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants