Adding warning icon to warning admonitions?

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi,

On my head, I'm often thinking about adding warning icon (more specifically,
circle exclamation) to warning admonition blocks. The idea is inspired by
content safety disclaimers as seen on TikTok (TT) (for example and FYI,
racing-themed contents there like [1] are more likely to get what I called
"pro-only" admonition that literally says `The actions in this video are
performed by professionals or supervised by professionals. Do not attempt.`)

From above inspiration, I'd like to make the warning admonition block from
currently:

```
+----------------------------------------------------------------------------+
|   Warning:                                                                 |
|                                                                            |
|   Function foo() can produce undefined behavior. Either sanitize           |
|   arguments being passed, or use the safer abstraction foo_wrapper().      |
+----------------------------------------------------------------------------+
```

into:

```
+----------------------------------------------------------------------------+
|   (!) Warning:                                                             |
|                                                                            |
|       Function foo() can produce undefined behaivor. Either sanitize       |
|       arguments being passed, or use the safer abstraction foo_wrapper().  |
+----------------------------------------------------------------------------+
```

or even to match TT:

```
+----------------------------------------------------------------------------+
|   (!) Function foo() can produce undefined behavior. Either sanitize       |
|       arguments being passed, or use the safer abstraction foo_wrapper().  |
+----------------------------------------------------------------------------+
```

In other words, the admonition text should be indented after the warning icon.

For the icon itself, the approach is to use Font Awesome [2] (many other doc
sites that uses Sphinx also do that due to site theme they use but Alabaster
theme don't use the icon, hence this question). I personally prefer regular
icon variant (like in TT), but alas it is in non-free PRO plan (and only
solid variant is free and that is what Sphinx themes using).

Does adding warning icon like above idea make sense for the kernel docs? And
does it require non-trivial (complex) changes to Alabaster theme?

Thanks.

[1]: https://www.tiktok.com/@supercars/video/7301916055063088392?is_from_webapp=1&sender_device=pc&web_id=7320595371066557959
[2]: https://fontawesome.com/icons/circle-exclamation?f=classic&s=solid

-- 
An old man doll... just what I always wanted! - Clara

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux