fix: docs

Author: psteinroe

docs/codegen/src/rules_docs.rs

@@ -17,7 +17,6 @@ use std::{
     str::{self, FromStr},
 };
 
-///
 /// Generates the documentation page for each lint rule.
 ///
 /// * `docs_dir`: Path to the docs directory.
@@ -64,23 +63,24 @@ fn generate_rule_doc(
 
     // add deprecation notice
     if let Some(reason) = &meta.deprecated {
-        writeln!(content, ":::caution[Deprecated]")?;
-        writeln!(content, "This rule is deprecated and will be removed in the next major release.\n**Reason**: {reason}")?;
-        writeln!(content, ":::")?;
+        writeln!(content, "> [!WARNING]")?;
+        writeln!(content, "> This rule is deprecated and will be removed in the next major release.\n**Reason**: {reason}")?;
     }
 
+    writeln!(content)?;
     writeln!(content, "**Since**: `v{}`", meta.version)?;
 
     // add recommended notice
     if is_recommended {
-        writeln!(content, ":::note")?;
+        writeln!(content, "> [!NOTE]")?;
         writeln!(
             content,
-            "- This rule is recommended. A diagnostic error will appear when linting your code."
+            "> - This rule is recommended. A diagnostic error will appear when linting your code."
         )?;
-        writeln!(content, ":::")?;
     }
 
+    writeln!(content)?;
+
     // add source information
     if !meta.sources.is_empty() {
         writeln!(content, "Sources: ")?;

docs/rules/ban-drop-column.md

@@ -1,9 +1,10 @@
 # banDropColumn
 **Diagnostic Category: `lint/safety/banDropColumn`**
+
 **Since**: `vnext`
-:::note
-- This rule is recommended. A diagnostic error will appear when linting your code.
-:::
+> [!NOTE]
+> - This rule is recommended. A diagnostic error will appear when linting your code.
+
 Sources: 
 - Inspired from: <a href="https://squawkhq.com/docs/ban-drop-column" target="_blank"><code>squawk/ban-drop-column</code></a>
 

docs/rules/ban-drop-not-null.md

@@ -1,9 +1,10 @@
 # banDropNotNull
 **Diagnostic Category: `lint/safety/banDropNotNull`**
+
 **Since**: `vnext`
-:::note
-- This rule is recommended. A diagnostic error will appear when linting your code.
-:::
+> [!NOTE]
+> - This rule is recommended. A diagnostic error will appear when linting your code.
+
 Sources: 
 - Inspired from: <a href="https://squawkhq.com/docs/ban-drop-not-null" target="_blank"><code>squawk/ban-drop-not-null</code></a>