Documentation missing
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 7
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
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).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the implementation of the moving average principal components analysis methods and the linked Neurostars discussion to identify what tedana users find confusing. The work is done when a documentation page clearly explains what the algorithm does and addresses the relevant user questions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100