PennLINC / fw-heudiconv

Heuristic-based Data Curation on Flywheel
BSD 3-Clause "New" or "Revised" License
6 stars 11 forks source link

Documentation Edits #78

Closed krmurtha closed 2 years ago

krmurtha commented 3 years ago

Describe the issue Reorder contents → page should work chronologically BIDS explained and general workflow should be first, suggest linking BIDS website as well (https://bids.neuroimaging.io), consider nesting the quickstart guide under this section, that way users who are more experienced can get the abbreviated information and move on, while people who need more guidance can continue to scroll through the rest of the tutorial

Installation: Add link to SDK section/documentation in installation section (currently included in quickstart but not in main installation tab) use https://docs.flywheel.io/hc/en-us/articles/360042106633-Find-your-SDK-version-and-upgrade)

Useage: fw-heudiconv-* --args section is kind of unnecessary, as they are explained well/in more detail in following subsections Heuristic: Including the example tabulate output in the github section was very helpful, might be useful to show in the other documentation Put examples of mandatory functions in the sections that explain what they do, (ie: examples of create key functions after create key explanation) Make headings on “optional variables” and the below explanations of the optional functions more clear → are the functions a type of optional variables? Are there examples of the optional variables?

Tips and Tricks: Move dataframe to string section before ASL, as it looks like it might be useful in the ASL section