docs icon indicating copy to clipboard operation
docs copied to clipboard

Add new note and warning admonitions to "Basic writing and formatting syntax"

Open HonkingGoose opened this issue 2 years ago • 4 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

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

Detail to understand the change

GitHub now supports note and warning admonitions in Markdown. Here's a live preview of them:

Note Note text

Warning Warning text

I don't know if this feature is still in beta (thus not documented), or if it's actually ready for production use.

If this feature is ready for production use, I would expect to find the new syntax in the linked article.

Why should the docs be changed?

The docs should match the current features for writing in Markdown on GitHub.

What is the expected outcome?

If feature in beta: keep issue around to remind you to fix it when it goes to production use.

If feature is ready for general use, close the issue with a PR with more documentation. Here's a rough todo list:

  • [ ] Create new section "Admonitions"
  • [ ] Show examples for Note and Warning admonition
  • [ ] Show syntax for the admonition

Additional information

No response

HonkingGoose avatar Dec 14 '22 10:12 HonkingGoose

👋 @HonkingGoose Thanks for opening an issue! We are checking on this internally, so I'll update when we have more information.

cmwilson21 avatar Dec 16 '22 14:12 cmwilson21

@cmwilson21 The stale bot is staling this automatically, but the issue still needs to be fixed. Can you please re-open my issue?

HonkingGoose avatar Apr 19 '23 10:04 HonkingGoose

@HonkingGoose Sure will! Sorry for the stale-bot closing it out. It seems to be acting a little wonky. Thank you for patience as we work through our backlog! 💖

cmwilson21 avatar Apr 19 '23 14:04 cmwilson21

This change is now live on Github but the docs still haven't been updated. What's going on? Surely updating the docs should be done alongside the change?

masterofimages avatar May 16 '23 12:05 masterofimages