Update comments for custom rules as requested by reviewer

TheOdinProject · Oct 28, 2024 · e383225 · e383225
1 parent 0124936
commit e383225
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
@@ -80,6 +80,8 @@
     // Disabled as it uses a different heading conversion algo to the TOP website
     "MD051": false
   },
+    // Custom rules specific to the project
+    // Docs for each rule can be found in `./markdownlint/docs`
   "customRules": [
     "./markdownlint/TOP001_descriptiveLinkText/TOP001_descriptiveLinkText.js",
     "./markdownlint/TOP002_noCodeInHeadings/TOP002_noCodeInHeadings.js",