lint: markdown linting added

.markdownlintignore

@@ -0,0 +1 @@
+node_modules

.markdownlintrc

@@ -0,0 +1,9 @@
+{
+  "default": true,
+  "header-increment": false,
+  "no-duplicate-header": false,
+  "no-inline-html": false,
+  "line-length": false,
+  "fenced-code-language": false,
+  "no-multiple-blanks": false
+}

README.md

@@ -53,7 +53,7 @@ audited version of the protocol.
 The `dev` branch is for active development & the latest code changes. Whenever a new PR with system contract changes is
 created it should be based on the `dev` branch.
 
-### Creating a new release:
+### Creating a new release
 
 Whenever a new release is planned, a new branch named `release-vX-<name>` should be created off the `dev` branch, where
 `X` represents the release version, and `<name>` is a short descriptive name for the release. The PR with the new
@@ -64,7 +64,7 @@ Once the audit for the release branch is complete and all the fixes from the aud
 changes into the `dev` branch. Once the release is final and merged into the `main` branch, the `main` branch should be
 merged back into the `dev` branch to keep it up-to-date.
 
-### Updating Unaudited Code:
+### Updating Unaudited Code
 
 Since scripts, READMEs, etc., are code that is not subject to audits, these are to be merged directly into the `main`
 branch. The rest of the release branches as well as the `dev` branch should merge `main` to synchronize with these

bootloader/test_infra/src/test_transactions/README.md

@@ -1,3 +1,5 @@
+# Test Transactions
+
 This directory contains JSON serialized 'Transaction' objects that are inserted into bootloader memory during
 unittesting.
 

package.json

@@ -26,6 +26,7 @@
     "@typescript-eslint/parser": "^6.7.4",
     "chai": "^4.3.6",
     "eslint": "^8.51.0",
+    "markdownlint-cli": "^0.37.0",
     "mocha": "^10.0.0",
     "prettier": "^3.0.3",
     "prettier-plugin-solidity": "^1.1.3",
@@ -54,9 +55,10 @@
     "clean:yul": "rm -rf ./bootloader/build ./bootloader/tests/artifacts ./contracts/artifacts ./contracts/precompiles/artifacts",
     "compile-yul": "ts-node scripts/compile-yul.ts",
     "deploy-preimages": "ts-node scripts/deploy-preimages.ts",
-    "lint": "yarn lint:sol && yarn lint:ts && yarn prettier:check",
-    "lint:ts": "eslint .",
+    "lint": "yarn lint:md && yarn lint:sol && yarn lint:ts && yarn prettier:check",
+    "lint:md": "markdownlint **/*.md",
     "lint:sol": "solhint 'contracts/**/*.sol'",
+    "lint:ts": "eslint .",
     "prettier:check": "prettier --check **/*.{js,json,md,sol,ts,yaml}",
     "prettier:write": "prettier --write **/*.{js,json,md,sol,ts,yaml}",
     "preprocess:yul": "rm -rf ./bootloader/build && yarn ts-node scripts/process.ts",