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

docs: improve readme format #3

Merged
merged 1 commit into from
Aug 29, 2024
Merged

docs: improve readme format #3

merged 1 commit into from
Aug 29, 2024

Conversation

MaferMazu
Copy link
Collaborator

@MaferMazu MaferMazu commented Aug 28, 2024

Description

This PR fixes the Readme badges and also changes the rst .. note:: notation to a bold format, because GitHub doesn't interpret very well that notes and shows them weirdly in the repo.

How to test

Check https://github.com/eduNEXT/tutor-contrib-picasso/tree/mfmz/format-notes-readme

@MaferMazu MaferMazu marked this pull request as ready for review August 28, 2024 20:46
Copy link
Contributor

@bra-i-am bra-i-am left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Maybe a non-blocking thought is that it would be better to change the file to Markdown for better highlighting of the notes and warning

@MaferMazu MaferMazu merged commit 70a084d into main Aug 29, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants