Leverage GitHub's new Note and Warning Markdown

docs/BUILD.md

@@ -53,7 +53,8 @@ sudo apt-get install -y powershell
 pwsh
 ```
 
-**Note** - If you get this error trying to install PowerShell:
+> **Note**
+> If you get this error trying to install PowerShell:
 
 ```
 powershell : Depends: libicu55 but it is not installable

docs/Diagnostics.md

@@ -6,7 +6,8 @@ This document describes various ways to debug and diagnose issues when using MsQ
 
 For debugging issues, logging is generally the best way to diagnose problems. MsQuic has extensive logs in the code to facilitate debugging. The logs can simply be converted to human readable text or they can be processed by various automated tools to help improve diagnostics.
 
-> **Note** - Currently tools only support Windows ETW.
+> **Note**
+> Currently tools only support Windows ETW.
 
 ### Windows
 
@@ -178,7 +179,8 @@ babeltrace --names all ./msquic_lttng/* > quic.babel.txt
 clog2text_lttng -i quic.babel.txt -s clog.sidecar -o quic.log --showTimestamp --showCpuInfo
 ```
 
-> **Note** - The `clog.sidecar` file that was used to build MsQuic must be used. It can be found in the `./src/manifest` directory of the repository.
+> **Note**
+> The `clog.sidecar` file that was used to build MsQuic must be used. It can be found in the `./src/manifest` directory of the repository.
 
 # Trace Analysis
 
@@ -192,7 +194,8 @@ When viewing the traces as text, we recommend [TextAnalysisTool.NET](https://tex
 
 You may also open the trace in Windows Performance Analyzer. See the [WPA instructions](../src/plugins/trace/README.md) for more details.
 
-> **Note** - WPA support for LTTng based logs is not yet available but will be supported in the future.
+> **Note**
+> WPA support for LTTng based logs is not yet available but will be supported in the future.
 
 # Performance Counters
 

docs/PGO.md

@@ -2,7 +2,8 @@
 
 MsQuic uses [profile-guided optimizations](https://docs.microsoft.com/en-us/cpp/build/profile-guided-optimizations) (PGO) to generate optimized builds of the MsQuic library. PGO lets you optimize the whole library by using data from a previous run of the library.
 
-> **Note** - This document is Windows specific.
+> **Note**
+> This document is Windows specific.
 
 # Build
 

docs/Settings.md

@@ -2,7 +2,8 @@
 
 MsQuic supports a number of configuration knobs (or settings). These settings can either be set dynamically (via the [QUIC_SETTINGS](./api/QUIC_SETTINGS.md) structure) or via persistent storage (e.g. registry on Windows).
 
-> **Important** - Generally MsQuic already choses the best / most correct default values for all settings. Settings should only be changed after due diligence and A/B testing is performed.
+> **Warning**
+> Generally MsQuic already choses the best / most correct default values for all settings. Settings should only be changed after due diligence and A/B testing is performed.
 
 MsQuic settings are available on most MsQuic API objects. [Here](#api-object-parameters) we'll provide an overview of them with links to further details.
 

docs/TEST.md

@@ -14,7 +14,8 @@ Then all the tests can be run with:
 ./scripts/test.ps1
 ```
 
-> **Note** - On Windows, `schannel` is the default TLS provider, but requires the latest Windows OS versions (Windows Server 2022 or Insider Preview) to function. If you don't have `schannel` use `openssl` to build and test.
+> **Note**
+> On Windows, `schannel` is the default TLS provider, but requires the latest Windows OS versions (Windows Server 2022 or Insider Preview) to function. If you don't have `schannel` use `openssl` to build and test.
 
 ```PowerShell
 ./scripts/test.ps1 -Tls openssl
@@ -26,7 +27,8 @@ By default this will run all tests in series, with no log collection. To include
 ./scripts/test.ps1 -LogProfile Full.Light
 ```
 
-> **Note** - On Windows, you will need to run Powershell as **Administrator** to get the logs.
+> **Note**
+> On Windows, you will need to run Powershell as **Administrator** to get the logs.
 
 If there are any failed tests, this will generate a directory for each failed test that includes the console output from running the test and any logs collected.
 

docs/TSG.md

@@ -248,7 +248,8 @@ Network Adapters:
    80 00-15-5D-AD-8B-40 433db3ea-0acd-457a-9c86-55bb7fa27391
 ```
 
-> **Note** - If you don't do this and use it to filter to a specific component, you will get a packet capture at **every** layer, which will include many duplicates of each packet.
+> **Note**
+> If you don't do this and use it to filter to a specific component, you will get a packet capture at **every** layer, which will include many duplicates of each packet.
 
 Once you find the interface you want, take note of the `Id`. For instance, in the example above, I want to use the Ethernet adapter, so I need `9`.
 
@@ -265,7 +266,8 @@ pktmon etl2pcap pktmon.etl
 
 This produced `pktmon.pcapng` in your current directory that can then be opened by [Wireshark](https://www.wireshark.org/). If you want to be able to decrypt the QUIC packets, you will need to get/export the TLS secrets from your code (todo: add link/instructions).
 
-> **Note** - If you don't specify the component in the `filter` step, you can specify it at the `etl2pcap` step: `pktmon etl2pcap pktmon.etl -c 9` and it will produce the same final output `pcapng` file.
+> **Note**
+> If you don't specify the component in the `filter` step, you can specify it at the `etl2pcap` step: `pktmon etl2pcap pktmon.etl -c 9` and it will produce the same final output `pcapng` file.
 
 # Trouble Shooting a Performance Issue
 

docs/Versions.md

@@ -12,7 +12,8 @@ An application may decide that it needs a specific feature only availble in one
 
 The first version in the list of `FullyDeployedVersions` will always be the initial version MsQuic starts the connection with.
 
-**NOTE: A client may only set a version that MsQuic supports. Any other value will cause [`SetParam`](api/SetParam.md) to fail.**
+> **Warning**
+> A client may only set a version that MsQuic supports. Any other value will cause [`SetParam`](api/SetParam.md) to fail.
 
 Use the following code snippet to change the default initial version, and only support a single QUIC version. It must be used before [`ConnectionStart`](api/ConnectionStart.md) is called:
 ```c

docs/api/StreamSend.md

@@ -83,7 +83,10 @@ MsQuic->StreamSend(
     AppSendContext);
 ```
 
-This example opens a new unidirectional stream, and queues a send that starts the stream, sends some app data and gracefully closes the stream. **Note** for the sake of brevity, error handling and clean up has been omitted.
+> **Note**
+> For the sake of brevity, error handling and clean up has been omitted.
+
+This example opens a new unidirectional stream, and queues a send that starts the stream, sends some app data and gracefully closes the stream.
 
 In some scenarios, the app may know that additional data (possibly on a different stream) will soon be queued after the current call to `StreamSend`. In these cases it may be helpful for the app to pass the `QUIC_SEND_FLAG_DELAY_SEND` flag to hint that MsQuic should wait for more data before flushing the connection-wide send queue. **Note** that anything else on the connection *might* still end up triggering the send to flush. The app may call `StreamSend` (on any stream) with a null/empty buffer with `QUIC_SEND_FLAG_DELAY_SEND` **unset** to force a flush.