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.

Sign up for GitHub

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

Jump to bottom

Documentation missing #42

Open
eurunuela opened this issue Jan 12, 2022 · 4 comments · May be fixed by #46
Open

Documentation missing #42

eurunuela opened this issue Jan 12, 2022 · 4 comments · May be fixed by #46
Labels
documentation Improvements or additions to documentation

Comments

@eurunuela
Copy link
Collaborator

eurunuela commented Jan 12, 2022 •
edited

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).
@eurunuela eurunuela added the documentation Improvements or additions to documentation label Jan 12, 2022
@tsalo
Copy link
Member

tsalo commented Jan 12, 2022

👍 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.

@eurunuela
Copy link
Collaborator Author

I'll try to go through the paper again and translate it into a step-by-step guide for the docs.

@eurunuela eurunuela linked a pull request Jan 17, 2022 that will close this issue
Draft
@eurunuela
Copy link
Collaborator Author

eurunuela commented Jan 21, 2022 •
edited

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.

@tsalo
Copy link
Member

tsalo commented Jan 21, 2022

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.

@tsalo tsalo mentioned this issue Mar 16, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add readthedocs page for mapca eurunuela/mapca
2 participants
@tsalo @eurunuela