NiMARE
NiMARE copied to clipboard
Create documentation for teaching users
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.
@jdkent created a repository for a Jupyter book (neurostuff/nimare-book
) where we can work on this.