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

Create documentation for teaching users #697

Open
tsalo opened this issue Jun 3, 2022 · 1 comment · May be fixed by #727
Open

Create documentation for teaching users #697

tsalo opened this issue Jun 3, 2022 · 1 comment · May be fixed by #727
Labels
documentation Improving documentation for the project opinions wanted A discussion item for which opinions would be appreciated.

Comments

@tsalo
Copy link
Member

tsalo commented Jun 3, 2022

Summary

During yesterday's Neurostore devs call, we talked a bit about the NiMARE documentation. Currently, there is a mix of methods descriptions (the NiMARE Methods page) and examples of NiMARE's functionality, but those two elements are very separate, and the examples are more a smattering of disconnected exhibitions than a tutorial.

We came up with the idea of making the documentation into more of a user guide. I'm not sure if this is something we can fit within the NiMARE documentation, where RTD will time out after ~10 minutes, or if we need to create the user guide in a separate location (e.g., a Jupyter Book). I'd love to get the other devs' thoughts on this.

We do also have a few different tutorials from previous events, like the OHBM notebook. There is also the NiMARE paper Jupyter Book, but that is more of a "deep dive" into different methods, rather than a user guide for new meta-analysts.

@tsalo tsalo added documentation Improving documentation for the project opinions wanted A discussion item for which opinions would be appreciated. labels Jun 3, 2022
@tsalo
Copy link
Member Author

tsalo commented Jun 10, 2022

@jdkent created a repository for a Jupyter book (neurostuff/nimare-book) where we can work on this.

@tsalo tsalo linked a pull request Jul 16, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improving documentation for the project opinions wanted A discussion item for which opinions would be appreciated.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant