Received-SPF: pass (google.com: domain of linux-kernel+bounces-17930-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Date: Fri, 5 Jan 2024 21:28:40 +0700
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>, Randy Dunlap <rdunlap@infradead.org>
Subject: Adding warning icon to warning admonitions?
Message-ID: <ZZgSGFhvT3SOI4fe@archie.me>
Precedence: bulk
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="T+v1tXslhN0Y+B0/"
Content-Disposition: inline


--T+v1tXslhN0Y+B0/
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

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.`)

=46rom 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 ic=
on.

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_we=
bapp=3D1&sender_device=3Dpc&web_id=3D7320595371066557959
[2]: https://fontawesome.com/icons/circle-exclamation?f=3Dclassic&s=3Dsolid

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

--T+v1tXslhN0Y+B0/
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCZZgSFQAKCRD2uYlJVVFO
o9jvAP0TsbAmH3dLPsJGiOxLBYbM6Em8AlIS/vNX+mDxeKRIkgD9FfYnRMMn5Fzc
Lzz8FPzqSBDaIxpzBJSHxRJC6XbsIAg=
=Gl9J
-----END PGP SIGNATURE-----

--T+v1tXslhN0Y+B0/--