Following this discussion on the Dataverse Google Group (https://groups.google.com/g/dataverse-community/c/wqQWsZjOU6U), I wonder if it would be interesting to display a README tab alongside Files, Metadata, etc.
This tab could display the README file if present, and could be activated only when available.
I don't know if it's a good idea or not, because with the other tabs, it could be cumbersome, and the trio (Files, Metadata, Terms) is the core for a dataset.
I'm putting this here—if the idea is not too silly, I could open an issue and help as much as I can with my limited technical resources :)
@Gwenaël Doux hi! I like the idea but how do you feel about that feature being in the new React frontend rather than the old JSF UI, which we will deprecate and remove some day.
I like the idea of making READMEs more visible, but how would this work with multiple READMEs? We get datasets from time to time with one general README and then READMEs for each folder in their dataset. Not sure how we would be able to differentiate.
Maybe it could work like the thumbnail image for a dataset. We let you choose from available images:
Screenshot 2026-01-16 at 9.03.02 AM.png
Philip Durbin 🚀 said:
Gwenaël Doux hi! I like the idea but how do you feel about that feature being in the new React frontend rather than the old JSF UI, which we will deprecate and remove some day.
Yes, definitely in the new ReactFrontEnd! It could be a new way to motivate people to make the transition
Great. Please feel free to create an issue at https://github.com/IQSS/dataverse-frontend/issues
When multiple READMEs occur, we should probably pick the one at the root of the dataset. I’m not sure, but I think that’s how it works with Software Heritage. It might work similarly to thumbnails; good catch!
Yeah, picking the one at the root makes sense to me.
Gwenaël Doux said:
When multiple READMEs occur, we should probably pick the one at the root of the dataset. I’m not sure, but I think that’s how it works with Software Heritage. It might work similarly to thumbnails; good catch!
Maybe the way GitHub and GitLab handle this with README files can be an inspiration here? Also, it would be good not only to support MarkDown, but eventually RestructuredText, AsciiDoc, etc as well.
I I opened an issue as suggest by Philip https://github.com/IQSS/dataverse-frontend/issues/911. I specified the formats supported for readme files
Last updated: Apr 03 2026 at 06:08 UTC