neurobagel / documentation

The neurobagel documentation
http://neurobagel.org/
MIT License
10 stars 6 forks source link

Deprecate or remove Nipoppy docs in favour of readthedocs? #218

Closed alyssadai closed 1 month ago

alyssadai commented 2 months ago

The idea here would be to keep the link but

alyssadai commented 2 months ago

@michellewang, let me know if you have any specific ideas for a blurb to replace this section!

michellewang commented 1 month ago

The Nipoppy Readthedocs are still missing a page for the tabular data, so right now the only thing we have in the docs that is relevant to Neurobagel would be the DICOM reorg and BIDSification parts, and in that case what Neurobagel expects the data to look like would be just BIDS

surchs commented 1 month ago

There are a couple of nipoppy links that now don't work anymore, see https://github.com/neurobagel/documentation/actions/runs/10816495878/job/30007788750?pr=223

@michellewang do you maybe have refactored the nipoppy repo recently?

michellewang commented 1 month ago

@surchs yes, the old Nipoppy docs on the Neurobagel website are obsolete. Pretty sure we can remove them now unless @nikhil153 says otherwise

alyssadai commented 1 month ago

Hey @surchs and @michellewang, since the old Nipoppy section is breaking checks in our docs right now, I would suggest we just address this issue by

  1. Removing the "Preparing data with Nipoppy" section
  2. Sticking a really short & simple admonition in the https://neurobagel.org/data_prep/ page for now, with something like:

Looking for broader/more general guidance on organizing the imaging and tabular data for your dataset?

We recommend also checking out [Nipoppy](link to docs), a protocol for standardized organization and processing of clinical-neuroimaging datasets that extends BIDS. Neurobagel tools are designed to be compatible with data organized according to the Nipoppy specification, although you do not necessarily need to use Nipoppy to use Neurobagel.

We can add more details in the future once there are more concrete links between Nipoppy outputs & Neurobagel, but I think for now this is sufficient

wdyt?

michellewang commented 1 month ago

Sounds good to me!