Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make README more appealing #10665

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Make README more appealing #10665

wants to merge 4 commits into from

Conversation

DS-INRAE
Copy link
Member

@DS-INRAE DS-INRAE commented Jul 3, 2024

What this PR does / why we need it:
Add sections for readability.
Expand the text and add emojis in an attempt to make it more attractive.

Special notes for your reviewer:
In Edit File for the updated README, you can access GitHub's MD previewer

Preview at https://github.com/DS-INRA/dataverse/blob/patch-1/README.md

Added sections, emojis and more links. Epanded the text
@DS-INRAE
Copy link
Member Author

Update: I will also add a table of contents for an easier navigation and readability

@jp-tosca
Copy link
Contributor

jp-tosca commented Jul 19, 2024

Hi @DS-INRA 👋🏼!

I was talking with @pdurbin on Zulip, you don't need HTML anchors or link to add a TOC for an MD file that lives in the repo, you can see as an example the notes for 6.3 here https://github.com/IQSS/dataverse/blob/develop/doc/release-notes/6.3-release-notes.md?plain=1

The only case where you need HTML tags is when is an MD file for the release BUT you only need the anchors:

<a id="table-of-contents"></a>
# Table of Contents
- [Release Highlights](#release-highlights)
- [Features](#features)
- [Bug Fixes](#bug-fixes)
- [API](#api)
- [Settings](#settings)
- [Complete List of Changes](#complete-list-of-changes)
- [Getting Help](#getting-help)
- [Upgrade instructions](#upgrade-instructions)

<a id="release-highlights"></a>
## Release Highlights

The links themselves don't need to be HTML, he has a point that it makes it harder to read from the console when we include HTML so it is a good practice not to add the code if it is not required/needed.

@pdurbin pdurbin added Size: 3 A percentage of a sprint. 2.1 hours. Size: 0.5 A percentage of a sprint. 0.35 hours and removed Size: 3 A percentage of a sprint. 2.1 hours. labels Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Size: 0.5 A percentage of a sprint. 0.35 hours
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants