docs(reference): mimic github notes and warning style (fastify#5973)

Author: Fdawgs

docs/Reference/ContentTypeParser.md

@@ -23,7 +23,7 @@ Note that for `GET` and `HEAD` requests, the payload is never parsed. For
 [catch-all](#catch-all) parser is not executed, and the payload is simply not
 parsed.
 
-> ## ⚠ Security Notice
+> ⚠ Warning:
 > When using regular expressions to detect `Content-Type`, it is important to
 > ensure proper detection. For example, to match `application/*`, use
 > `/^application\/([\w-]+);?/` to match the
@@ -152,8 +152,8 @@ fastify.addContentTypeParser('text/xml', function (request, payload, done) {
 })
 ```
 
-**Notice**: `function(req, done)` and `async function(req)` are
-still supported but deprecated.
+> 🛈 Note: `function(req, done)` and `async function(req)` are
+> still supported but deprecated.
 
 #### Body Parser
 The request body can be parsed in two ways. First, add a custom content type

docs/Reference/Hooks.md

@@ -34,9 +34,9 @@ are Request/Reply hooks and application hooks:
 - [Using Hooks to Inject Custom Properties](#using-hooks-to-inject-custom-properties)
 - [Diagnostics Channel Hooks](#diagnostics-channel-hooks)
 
-**Notice:** the `done` callback is not available when using `async`/`await` or
-returning a `Promise`. If you do invoke a `done` callback in this situation
-unexpected behavior may occur, e.g. duplicate invocation of handlers.
+> 🛈 Note: The `done` callback is not available when using `async`/`await` or
+> returning a `Promise`. If you do invoke a `done` callback in this situation
+> unexpected behavior may occur, e.g. duplicate invocation of handlers.
 
 ## Request/Reply Hooks
 
@@ -68,9 +68,9 @@ fastify.addHook('onRequest', async (request, reply) => {
 })
 ```
 
-**Notice:** in the [onRequest](#onrequest) hook, `request.body` will always be
-`undefined`, because the body parsing happens before the
-[preValidation](#prevalidation) hook.
+> 🛈 Note: In the [onRequest](#onrequest) hook, `request.body` will always be
+> `undefined`, because the body parsing happens before the
+> [preValidation](#prevalidation) hook.
 
 ### preParsing
 
@@ -98,17 +98,17 @@ fastify.addHook('preParsing', async (request, reply, payload) => {
 })
 ```
 
-**Notice:** in the [preParsing](#preparsing) hook, `request.body` will always be
-`undefined`, because the body parsing happens before the
-[preValidation](#prevalidation) hook.
+> 🛈 Note: In the [preParsing](#preparsing) hook, `request.body` will always be
+> `undefined`, because the body parsing happens before the
+> [preValidation](#prevalidation) hook.
 
-**Notice:** you should also add a `receivedEncodedLength` property to the
-returned stream. This property is used to correctly match the request payload
-with the `Content-Length` header value. Ideally, this property should be updated
-on each received chunk.
+> 🛈 Note: You should also add a `receivedEncodedLength` property to the
+> returned stream. This property is used to correctly match the request payload
+> with the `Content-Length` header value. Ideally, this property should be updated
+> on each received chunk.
 
-**Notice:** The size of the returned stream is checked to not exceed the limit
-set in [`bodyLimit`](./Server.md#bodylimit) option.
+> 🛈 Note: The size of the returned stream is checked to not exceed the limit
+> set in [`bodyLimit`](./Server.md#bodylimit) option.
 
 ### preValidation
 
@@ -166,8 +166,8 @@ fastify.addHook('preSerialization', async (request, reply, payload) => {
 })
 ```
 
-Note: the hook is NOT called if the payload is a `string`, a `Buffer`, a
-`stream`, or `null`.
+> 🛈 Note: The hook is NOT called if the payload is a `string`, a `Buffer`, a
+> `stream`, or `null`.
 
 ### onError
 ```js
@@ -196,8 +196,8 @@ user
 *(Note that the default error handler always sends the error back to the
 user)*.
 
-**Notice:** unlike the other hooks, passing an error to the `done` function is not
-supported.
+> 🛈 Note: Unlike the other hooks, passing an error to the `done` function is not
+> supported.
 
 ### onSend
 If you are using the `onSend` hook, you can change the payload. For example:
@@ -233,8 +233,8 @@ fastify.addHook('onSend', (request, reply, payload, done) => {
 > to `0`, whereas the `Content-Length` header will not be set if the payload is
 > `null`.
 
-Note: If you change the payload, you may only change it to a `string`, a
-`Buffer`, a `stream`, a `ReadableStream`, a `Response`, or `null`.
+> 🛈 Note: If you change the payload, you may only change it to a `string`, a
+> `Buffer`, a `stream`, a `ReadableStream`, a `Response`, or `null`.
 
 
 ### onResponse
@@ -256,8 +256,8 @@ The `onResponse` hook is executed when a response has been sent, so you will not
 be able to send more data to the client. It can however be useful for sending
 data to external services, for example, to gather statistics.
 
-**Note:** setting `disableRequestLogging` to `true` will disable any error log
-inside the `onResponse` hook. In this case use `try - catch` to log errors.
+> 🛈 Note: Setting `disableRequestLogging` to `true` will disable any error log
+> inside the `onResponse` hook. In this case use `try - catch` to log errors.
 
 ### onTimeout
 
@@ -298,7 +298,8 @@ The `onRequestAbort` hook is executed when a client closes the connection before
 the entire request has been processed. Therefore, you will not be able to send
 data to the client.
 
-**Notice:** client abort detection is not completely reliable. See: [`Detecting-When-Clients-Abort.md`](../Guides/Detecting-When-Clients-Abort.md)
+> 🛈 Note: Client abort detection is not completely reliable.
+> See: [`Detecting-When-Clients-Abort.md`](../Guides/Detecting-When-Clients-Abort.md)
 
 ### Manage Errors from a hook
 If you get an error during the execution of your hook, just pass it to `done()`
@@ -451,8 +452,8 @@ fastify.addHook('onListen', async function () {
 })
 ```
 
-> **Note**
-> This hook will not run when the server is started using `fastify.inject()` or `fastify.ready()`
+> 🛈 Note: This hook will not run when the server is started using
+> fastify.inject()` or `fastify.ready()`.
 
 ### onClose
 <a id="on-close"></a>
@@ -575,8 +576,8 @@ This hook can be useful if you are developing a plugin that needs to know when a
 plugin context is formed, and you want to operate in that specific context, thus
 this hook is encapsulated.
 
-**Note:** This hook will not be called if a plugin is wrapped inside
-[`fastify-plugin`](https://github.com/fastify/fastify-plugin).
+> 🛈 Note: This hook will not be called if a plugin is wrapped inside
+> [`fastify-plugin`](https://github.com/fastify/fastify-plugin).
 ```js
 fastify.decorate('data', [])
 
@@ -773,7 +774,7 @@ fastify.route({
 })
 ```
 
-**Note**: both options also accept an array of functions.
+> 🛈 Note: Both options also accept an array of functions.
 
 ## Using Hooks to Inject Custom Properties
 <a id="using-hooks-to-inject-custom-properties"></a>
@@ -860,7 +861,7 @@ channel.subscribe(function ({ fastify }) {
 })
 ```
 
-> **Note:** The TracingChannel class API is currently experimental and may undergo
+> 🛈 Note: The TracingChannel class API is currently experimental and may undergo
 > breaking changes even in semver-patch releases of Node.js.
 
 Five other events are published on a per-request basis following the

docs/Reference/Logging.md

@@ -157,11 +157,11 @@ const fastify = require('fastify')({
 });
 ```
 
-**Note**: In some cases, the [`Reply`](./Reply.md) object passed to the `res`
-serializer cannot be fully constructed. When writing a custom `res` serializer,
-check for the existence of any properties on `reply` aside from `statusCode`,
-which is always present. For example, verify the existence of `getHeaders`
-before calling it:
+> 🛈 Note: In some cases, the [`Reply`](./Reply.md) object passed to the `res`
+> serializer cannot be fully constructed. When writing a custom `res`
+> serializer, check for the existence of any properties on `reply` aside from
+> `statusCode`, which is always present. For example, verify the existence of
+> `getHeaders` before calling it:
 
 ```js
 const fastify = require('fastify')({
@@ -184,7 +184,7 @@ const fastify = require('fastify')({
 });
 ```
 
-**Note**: The body cannot be serialized inside a `req` method because the
+> 🛈 Note: The body cannot be serialized inside a `req` method because the
 request is serialized when the child logger is created. At that time, the body
 is not yet parsed.
 
@@ -199,10 +199,10 @@ app.addHook('preHandler', function (req, reply, done) {
 })
 ```
 
-**Note**: Ensure serializers never throw errors, as this can cause the Node
-process to exit. See the
-[Pino documentation](https://getpino.io/#/docs/api?id=opt-serializers) for more
-information.
+> 🛈 Note: Ensure serializers never throw errors, as this can cause the Node
+> process to exit. See the
+> [Pino documentation](https://getpino.io/#/docs/api?id=opt-serializers) for more
+> information.
 
 *Any logger other than Pino will ignore this option.*
 

docs/Reference/Middleware.md

@@ -50,8 +50,8 @@ that already has the Fastify [Request](./Request.md#request) and
 To run middleware under certain paths, pass the path as the first parameter to
 `use`.
 
-*Note: This does not support routes with parameters (e.g. `/user/:id/comments`)
-and wildcards are not supported in multiple paths.*
+> 🛈 Note: This does not support routes with parameters
+> (e.g. `/user/:id/comments`) and wildcards are not supported in multiple paths.
 
 ```js
 const path = require('node:path')

docs/Reference/Reply.md

@@ -151,7 +151,7 @@ fastify.get('/', async function (req, rep) {
 Sets a response header. If the value is omitted or undefined, it is coerced to
 `''`.
 
-> Note: the header's value must be properly encoded using
+> 🛈 Note: The header's value must be properly encoded using
 > [`encodeURI`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI)
 > or similar modules such as
 > [`encodeurl`](https://www.npmjs.com/package/encodeurl). Invalid characters
@@ -260,11 +260,11 @@ requires heavy resources to be sent after the `data`, for example,
 `Server-Timing` and `Etag`. It can ensure the client receives the response data
 as soon as possible.
 
-*Note: The header `Transfer-Encoding: chunked` will be added once you use the
-trailer. It is a hard requirement for using trailer in Node.js.*
+> 🛈 Note: The header `Transfer-Encoding: chunked` will be added once you use
+> the trailer. It is a hard requirement for using trailer in Node.js.
 
-*Note: Any error passed to `done` callback will be ignored. If you interested
-in the error, you can turn on `debug` level logging.*
+> 🛈 Note: Any error passed to `done` callback will be ignored. If you interested
+> in the error, you can turn on `debug` level logging.*
 
 ```js
 reply.trailer('server-timing', function() {
@@ -314,7 +314,7 @@ reply.getTrailer('server-timing') // undefined
 Redirects a request to the specified URL, the status code is optional, default
 to `302` (if status code is not already set by calling `code`).
 
-> Note: the input URL must be properly encoded using
+> 🛈 Note: The input URL must be properly encoded using
 > [`encodeURI`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI)
 > or similar modules such as
 > [`encodeurl`](https://www.npmjs.com/package/encodeurl). Invalid URLs will
@@ -823,8 +823,8 @@ automatically create an error structured as the following:
 You can add custom properties to the Error object, such as `headers`, that will
 be used to enhance the HTTP response.
 
-*Note: If you are passing an error to `send` and the statusCode is less than
-400, Fastify will automatically set it at 500.*
+> 🛈 Note: If you are passing an error to `send` and the statusCode is less than
+> 400, Fastify will automatically set it at 500.
 
 Tip: you can simplify errors by using the
 [`http-errors`](https://npm.im/http-errors) module or
@@ -871,7 +871,7 @@ fastify.get('/', {
 If you want to customize error handling, check out
 [`setErrorHandler`](./Server.md#seterrorhandler) API.
 
-*Note: you are responsible for logging when customizing the error handler*
+> 🛈 Note: you are responsible for logging when customizing the error handler.
 
 API:
 

docs/Reference/Request.md

@@ -84,8 +84,8 @@ This operation adds new values to the request headers, accessible via
 For performance reasons, `Symbol('fastify.RequestAcceptVersion')` may be added
 to headers on `not found` routes.
 
-> Note: Schema validation may mutate the `request.headers` and
-`request.raw.headers` objects, causing the headers to become empty.
+> 🛈 Note: Schema validation may mutate the `request.headers` and
+> `request.raw.headers` objects, causing the headers to become empty.
 
 ```js
 fastify.post('/:params', options, function (request, reply) {

docs/Reference/Routes.md

@@ -376,12 +376,12 @@ fastify.get('/', options, async function (request, reply) {
 })
 ```
 
-**Warning:**
-* When using both `return value` and `reply.send(value)`, the first one takes
-  precedence, the second is discarded, and a *warn* log is emitted.
-* Calling `reply.send()` outside of the promise is possible but requires special
-  attention. See [promise-resolution](#promise-resolution).
-* `undefined` cannot be returned. See [promise-resolution](#promise-resolution).
+> ⚠ Warning:
+> * When using both `return value` and `reply.send(value)`, the first one takes
+>   precedence, the second is discarded, and a *warn* log is emitted.
+> * Calling `reply.send()` outside of the promise is possible but requires special
+>   attention. See [promise-resolution](#promise-resolution).
+> * `undefined` cannot be returned. See [promise-resolution](#promise-resolution).
 
 ### Promise resolution
 <a id="promise-resolution"></a>
@@ -659,7 +659,7 @@ fastify.inject({
 })
 ```
 
-> ## ⚠  Security Notice
+> ⚠ Warning:
 > Set a
 > [`Vary`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Vary)
 > header in responses with the value used for versioning
@@ -771,7 +771,7 @@ const secret = {
 }
 ```
 
-> ## ⚠  Security Notice
+> ⚠ Warning:
 > When using asynchronous constraints, avoid returning errors inside the
 > callback. If errors are unavoidable, provide a custom `frameworkErrors`
 > handler to manage them. Otherwise, route selection may break or expose