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

the ''important'' alert isn't documented #35860

Open
1 task done
Michael21107 opened this issue Jan 8, 2025 · 4 comments
Open
1 task done

the ''important'' alert isn't documented #35860

Michael21107 opened this issue Jan 8, 2025 · 4 comments
Labels
content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs

Comments

@Michael21107
Copy link
Contributor

Michael21107 commented Jan 8, 2025

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide#alerts

What part(s) of the article would you like to see updated?

There is no mention of a fifth alert type, ''important'' (> [!important]), in the documentation. The alert is available in the preview of slash commands.

Additional information

No response

@Michael21107 Michael21107 added the content This issue or pull request belongs to the Docs Content team label Jan 8, 2025
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 8, 2025
@nguyenalex836
Copy link
Contributor

@Michael21107 Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

@nguyenalex836 nguyenalex836 added contributing docs Content related to our contributing docs waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jan 8, 2025
@subatoi
Copy link
Contributor

subatoi commented Jan 9, 2025

@Michael21107 You're correct, thanks for spotting that! Feel free to open a PR for this (thanks for raising an issue first 🙏 ), else we'll open this up to contributors 👍

@nguyenalex836 nguyenalex836 removed the waiting for review Issue/PR is waiting for a writer's review label Jan 9, 2025
@Michael21107
Copy link
Contributor Author

I started on the fix, but the longer description is above my abilities.

@nguyenalex836
Copy link
Contributor

I started on the fix, but the longer description is above my abilities.

@Michael21107 No problem at all! Feel free to take the PR out of draft state, and we'll have the team review and make suggestions regarding the description 💛

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs
Projects
None yet
Development

No branches or pull requests

3 participants