-
Notifications
You must be signed in to change notification settings - Fork 8
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
Documentation missing #42
Comments
👍 on this. I really like the graph you put together for the post and think it would be good to add it (or something similar) to the documentation. |
I'll try to go through the paper again and translate it into a step-by-step guide for the docs. |
Hey @tsalo , I wanted to get your opinion on this: would it make more sense to have our docs written in a Jupyter Book rather than a readthedocs page? Edit: thinking behind this would be that a Jupyter Book would make the "docs" interactive, which could help with understanding the method. |
I think an interactive walkthrough would be great, although I think a Jupyter Book might be overkill given how small mapca is. What about having our walkthrough as an example with a Binder link? Or multiple examples in a gallery. |
I believe we should add a documentation page that clearly explains what the algorithm does.
I think it would make it easier to understand for users of
tedana
especially, as we receive some questions about it in Neurostars (see this post for example).The text was updated successfully, but these errors were encountered: