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

feat: use GitHub's markdown alerts for warnings in README #883

Merged
merged 1 commit into from
Apr 2, 2024

Conversation

ayhon
Copy link
Contributor

@ayhon ayhon commented Mar 30, 2024

Relatively recently GitHub has added support for adding a "callout" element in markdown files (source). I was reading the README and thought it could be something the project might be interested in using, since it has a couple of warnings in the README.

Instead of

⚠️ Warning! ⚠️ : Critical content demanding immediate user attention due to potential risks.

it is shown like

Warning

Critical content demanding immediate user attention due to potential risks.

which in my opinion stands out more, which is why I thought you might find it interesting.

This is achieved with the following markdown

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

@eclipse-zenoh-bot
Copy link
Contributor

@ayhon If this pull request contains a bugfix or a new feature, then please consider using Closes #ISSUE-NUMBER syntax to link it to an issue.

@JEnoch
Copy link
Member

JEnoch commented Apr 2, 2024

Thanks for your contribution!
That's indeed more catchy and nicer to read 😃

@JEnoch JEnoch enabled auto-merge (squash) April 2, 2024 07:38
@JEnoch JEnoch merged commit 02d4783 into eclipse-zenoh:main Apr 2, 2024
9 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.

3 participants