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

Possible improvements for the user guide #719

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

Possible improvements for the user guide #719

ghost opened this issue Jun 16, 2022 · 1 comment · May be fixed by #727
Labels
documentation Improving documentation for the project enhancement New feature or request

Comments

@ghost
Copy link

ghost commented Jun 16, 2022

As someone who heard from NiMARE the first time today, I had some problems to follow the current example guide. First, the example and NiMARE pages are not connected, so that a code example often contains no explanation (e.g. Coordinate-based meta-analysis algorithms), and the explanation no code example.
A second problem would be, at least at the first glance, that the guide does not contain a workflow or whole example, so that you first need to sort out, where the step should be apllied.

Maybe examples and methods could be merged into a unified user guide, or at least contain links to each other. This could contain a workflow from dataset to meta analysis up to further analyses. Maybe with links to in depth explanations.

@ghost ghost added the enhancement New feature or request label Jun 16, 2022
@tsalo tsalo added the documentation Improving documentation for the project label Jun 16, 2022
@tsalo
Copy link
Member

tsalo commented Jun 30, 2022

Thank you @gerionreimann. We have been discussing building more user-oriented documentation, but one major problem with our current setup is that even our current examples often take too long for ReadTheDocs. We've been looking into making a Jupyter Book for users, to be located in neurostuff/nimare-book.

When you say that there is no workflow or whole example, what specifically are you looking for? NiMARE can do many different things, so I think the specific walkthroughs we provide will need to depend on what users want to do. What would constitute a whole example for you?

@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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant