chore: add justification for disabled markdownlint rules

.github/ISSUE_TEMPLATE/bug_report.md

@@ -20,7 +20,8 @@ A clear and concise description of what you expected to happen.
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-**Framework version (please check if it happens with the last Fuego version before posting):**
+**Framework version (please check if it happens with the last
+Fuego version before posting):**
 
 **Go version (please check if it happens with the last Go version before posting):**
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,7 +8,8 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+A clear and concise description of what the problem is.
+Ex. I'm always frustrated when [...]
 
 **Describe the solution you'd like**
 A clear and concise description of what you want to happen.

.github/workflows/lint.yaml

@@ -9,6 +9,8 @@ jobs:
   markdownlint:
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v4
+
       - name: markdownlint-cli
         uses: nosborn/github-action-markdown-cli@v3.3.0
         with:

.markdownlint.yaml

@@ -1,9 +1,22 @@
-MD001: false
-
+# MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md010.md
+#
+# The rendered markdown is viewed in github and
+# the Docusaurus site which render hard-tabs fine.
+# It is annoying to have to deal with so many spaces
+# specifically in golang code blocks.
 MD010: false
 
+# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
 MD013:
+  # Applying line length to code blocks
+  # makes the code look worse sometimes.
   code_blocks: false
+  # Applying line length to tables makes
+  # it more difficult to edit.
   tables: false
 
+# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
+#
+# It's more convenient to work with HTML in some cases.
+# We use HTML in a lot of our docs.
 MD033: false

Makefile

@@ -30,7 +30,7 @@ lint:
 	go run github.com/golangci/golangci-lint/cmd/golangci-lint@latest run
 
 lint-markdown:
-	markdownlint --fix .
+	markdownlint --dot .
 
 example:
 	( cd examples/full-app-gourmet && go run . -debug )

README.md

@@ -22,22 +22,25 @@ see [the example](./examples/full-app-gourmet) - actually running [in prod](http
 
 ## Sponsors
 
-Fuego is proudly sponsored by [Zuplo](https://zuplo.link/fuego-gh), that provides [a Fuego integration](https://zuplo.link/fuego-gh)!
+Fuego is proudly sponsored by [Zuplo](https://zuplo.link/fuego-gh),
+that provides [a Fuego integration](https://zuplo.link/fuego-gh)!
 
 <div align="center">
-<img src="./assets/Zuplo.png" style="border-radius:10px" height="100" alt="Fuego Logo" />
+	<img src="./assets/Zuplo.png" style="border-radius:10px" height="100"
+	alt="Fuego Logo" />
 </div>
 
-> Zuplo allows you to secure your Fuego API, scale it globally, generate documentation from your OpenAPI, and monetize your users.
+> Zuplo allows you to secure your Fuego API, scale it globally,
+generate documentation from your OpenAPI, and monetize your users.
 
 ## Why Fuego?
 
 Chi, Gin, Fiber and Echo are great frameworks.
 But since they were designed a long time ago,
-[their current API does not allow them][gin-gonic-issue]
-to deduce OpenAPI types from signatures, things that are
-now possible with generics. Fuego offers a lot of "modern Go based"
-features that make it easy to develop APIs and web applications.
+[their current API does not allow them][gin-gonic-issue] to deduce
+OpenAPI types from signatures, things that are now possible with generics.
+Fuego offers a lot of "modern Go based" features that make it easy
+to develop APIs and web applications.
 
 ## Features
 

documentation/README.md

@@ -3,7 +3,7 @@
 This website is built using [Docusaurus](https://docusaurus.io/),
 a modern static website generator.
 
-### Installation
+## Installation
 
 ```sh
 yarn