-
Notifications
You must be signed in to change notification settings - Fork 83
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
Harmonize admontions in style guide #499
Conversation
This PR aims to harmonize our admonitions style guide to what is available on Docusaurus. The wording are adapted from [Grafana](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/) and [Codeberg](https://docs.codeberg.org/improving-documentation/style-guide/) style guides. Also with a little bit help of ChatGPT. The prompt is attached below : > Me : We want to harmonize our style guide on admonitions with whats available on docusaurus. What we have right now are adopted from Redhat. Redhat have four admonitions: Note, Important, Warning/Danger, and Tip. Docusaurus gives us five options : Note, Tip, Info, Important, Warning and Danger. Notice how docusaurus separate Warning and Danger, while Redhat don't. How would you describe those admonitions? > > ChatGPT : Sure, here's a breakdown of how you might describe each of these admonitions: >1. **Note**: Used to provide additional information or clarification that is not critical but can enhance understanding. >2. **Tip**: Offers a helpful suggestion or advice that can improve the user's experience or workflow. >3. **Info**: Provides general information that may be useful or relevant to the reader but isn't necessarily a warning or a tip. >4. **Important**: Highlights information that is crucial for the reader to understand or follow for successful completion of a task or to avoid issues. >5. **Warning**: Indicates a potential hazard, risk, or consequence that the reader should be aware of and take precautions against. >6. **Danger**: Indicates an imminent or severe risk that could lead to serious consequences if not addressed or avoided immediately. >While Redhat combines "Warning" and "Danger" into one category, Docusaurus separates them, perhaps to provide more granularity in communicating the severity of the cautionary message. Resolves getsolus#495
0d63684
to
3e8abb7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One nit and a general note.
In future, let's be cautious of using ChatGPT to do the actual writing; although I can see you didn't actually use the suggestions directly here. We are asserting copyright on our help center content, and ChatGPT may muddy that.
I disclose that information to be transparent. I understand that it can muddy the copyright. I just found it useful to brainstorm. I promise not not copy it verbatim out of ChatGPT or any other AI service. Cheers! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the fix!
Description
This PR aims to harmonize our admonitions style guide to what is available on Docusaurus. The wording are adapted from Grafana and Codeberg style guides. Also with a little bit help of ChatGPT. The prompt is attached below :
Resolves #495