Skip to content

Feature Request/Idea: Add README tab to display dataset documentation (similar to software forges) #911

@gwendoux

Description

@gwendoux

Overview of the Feature Request

Currently, there is no standardized way to display human-readable documentation or overview information for a dataset directly on its landing page. Users often need to download and open individual files to understand the dataset's purpose, structure, and usage guidelines, or at best, use the markdown or text previewer.
In case there are multiple README files, the one at the root of the dataset should be picked.

As discussed in this thread (#community > Add README tab to display dataset documentation) This feature could support Markdown, Plain text, RestructuredText, AsciiDoc, etc

What kind of user is the feature intended for?
User, depositor

What inspired the request?
Software forges like GitHub, GitLab, and Bitbucket have successfully implemented README file displays that provide immediate context to visitors.

What existing behavior do you want changed?

Any brand-new behavior do you want to add to Dataverse?

Add a new tab beside Files and Terms to display the README file of the dataset. I don't have a strong opinion regarding the default tab (but the files tab should be default unless a big restructuring of the dataset page is on track)

Any open or closed issues related to this feature request?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions