Stream: docs

Topic: README #10665


view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 19 2024 at 18:57):

@Juan Pablo Tosca Villanueva what have you done?

Now you've got @Dimitri Szabo excited about putting a table of contents in Markdown: https://github.com/IQSS/dataverse/pull/10665/files/0fd9fce1c9dfbbac9e69961c70fceba8eeef6a48..e3f47c5b9ce5dd79a6dc439289dfb7148ea45d47

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 18:58):

:see_no_evil:

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 18:58):

I plead the fifth :rolling_eyes:

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 18:58):

:rolling_on_the_floor_laughing:

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 19 2024 at 19:18):

Maybe I'm old school but I like being able to look at READMEs from a terminal.

When they start having HTML in them, they are much less readable from the command line.

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:19):

The only one that needs HTML is the one from the release notes

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 19 2024 at 19:24):

The commit above is for our main README ^^

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:27):

He doesn't need HTML for links if an .MD is in the repo

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:28):

https://github.com/IQSS/dataverse/blob/develop/doc/release-notes/6.3-release-notes.md?plain=1

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:33):

I wrote a message

view this post on Zulip Juan Pablo Tosca Villanueva (Jul 19 2024 at 19:33):

https://github.com/IQSS/dataverse/pull/10665#issuecomment-2239987918

view this post on Zulip Dimitri Szabo (Jul 22 2024 at 15:05):

Hi, thanks for the check and the feedback, I agree that it is better with simple markdown, I just got influenced by the frontend's README.
It's changed :)

view this post on Zulip Dimitri Szabo (Jul 22 2024 at 15:05):

I'll have to change the logo too I didn't notice the logo was in the dataverse repository too

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 23 2024 at 15:24):

Here's some feedback we got on our README back in 2017: https://github.com/LappleApple/feedmereadmes/issues/26

view this post on Zulip Dimitri Szabo (Jul 23 2024 at 15:29):

Interesting, I'll have a look at the discussion and the maturity model, thanks!

view this post on Zulip Philip Durbin ๐Ÿš€ (Sep 27 2024 at 13:28):

@Dimitri Szabo I added "Preview at https://github.com/DS-INRA/dataverse/blob/patch-1/README.md " to your PR (#10665). I hope you don't mind.

view this post on Zulip Philip Durbin ๐Ÿš€ (Sep 27 2024 at 13:29):

Also, I was wondering if you'd want to talk about it during a future docs meeting. See #docs > doc group meeting

view this post on Zulip Dimitri Szabo (Sep 30 2024 at 15:54):

I am not sure yet I'll be able to attend but I added the next Docs meeting to my agenda. I'll let you know if I can make it :)

view this post on Zulip Philip Durbin ๐Ÿš€ (Nov 25 2024 at 21:02):

I finally left a review: https://github.com/IQSS/dataverse/pull/10665#pullrequestreview-2459609385

view this post on Zulip Philip Durbin ๐Ÿš€ (Nov 25 2024 at 21:03):

I'd love Dimitri to take a look but all docs wg folks and everyone actually is welcome to take a look.

view this post on Zulip Dimitri Szabo (Nov 28 2024 at 09:22):

Philip Durbin ๐Ÿ‰ said:

I finally left a review: https://github.com/IQSS/dataverse/pull/10665#pullrequestreview-2459609385

Great, I see there are many comments, I shall look into it next week! Thanks!

view this post on Zulip Philip Durbin ๐Ÿš€ (Dec 16 2024 at 14:34):

@Dimitri Szabo yes, a few comments. Please do take a look. Thanks!

view this post on Zulip Philip Durbin ๐Ÿš€ (Jan 27 2025 at 12:55):

#10665 has been merged! Thanks, @Dimitri Szabo


Last updated: Nov 01 2025 at 14:11 UTC