IQSS / IQSS/dataverse-frontend

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

Open
#911 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
31
Forks
26
Avg merge
4d 13h
Merged PRs (30d)
4

Description

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or code entry points are named. Start by locating the dataset landing page and its existing Files and Terms tabs; done should mean a README tab displays the root README when one exists and supports the documented text formats.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.