Add instructions for embedding images within the DLP Description field
#200
Conversation
|
This is a cool idea! But do we want to allow and encourage users to link to external images? That conflicts a bit with the idea that we want to metadata to be persistent and unchanging for a given dandiset version. What if we somehow stored these images any linked image in a place we control? |
That's a fair point. Perhaps we could have users upload images to the Dandiset with the |
Inspired by the success of the bids-standard#1962 adding formalization of `logs/` folder, and triggered by the use-case in DANDI dandi/dandi-docs#200 seeking to add more elaborate descriptions to the README (or more specifically README.md), I would like to propose adding any extra documentation and associated artwork (images, videos, etc) under `docs/` folder. I do not think it is worth breaking down more (as videos/) etc, since it could confuse with data types (videos of behavior or alike). Not sure if we would want to formalize inner structure anyhow. We could potentially recommend using `docs/images/` subfolder for images. Then README.md on top level could potentially use those images via references to `docs/` paths.
|
yes, ideally we should allow for that at BIDS level as well, hence fresh |
3 participants
Fix dandi/dandi-archive#2299
cc @jeromelecoq