docs: workflow and linter improvements

.github/PULL_REQUEST_TEMPLATE.md

@@ -15,7 +15,7 @@ closes: #XXXX
 
 ### Commit Message / Changelog Entry
 
-```bash
+```text
 type: commit message
 ```
 

.github/workflows/link-check.yml

@@ -1,10 +1,14 @@
 name: Check Markdown links
-on: pull_request
+on:
+  pull_request:
+    paths:
+      - "**.md"
+      - "!.github/**"
 jobs:
   markdown-link-check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: gaurav-nelson/github-action-markdown-link-check@v1
-      with:
-        config-file: '.github/workflows/link-check-config.json'
+      - uses: actions/checkout@v3
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          config-file: '.github/workflows/link-check-config.json'

.github/workflows/markdown-lint.yml

@@ -0,0 +1,23 @@
+name: Markdown Lint
+on:
+  pull_request:
+    paths:
+      - "**.md"
+      - "!.github/**"
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: tj-actions/changed-files@v35
+        id: changed-files
+        with:
+          files: "**/*.md"
+          separator: ","
+      - uses: DavidAnson/markdownlint-cli2-action@v10
+        if: steps.changed-files.outputs.any_changed == 'true'
+        with:
+          globs: ${{ steps.changed-files.outputs.all_changed_files }}
+          separator: ","

.markdownlint-cli2.jsonc

@@ -0,0 +1,12 @@
+// This file is used by markdownlint-cli2 to configure the linting process
+// in conjunction with .markdownlint.jsonc.
+{
+  "ignores": [
+    "docs/node_modules/**",
+    ".github",
+    "CHANGELOG.md",
+    "vendor/**",
+    "e2e/vendor/**",
+    "modules/capability/vendor/**"
+  ]
+}

.markdownlint.jsonc

@@ -1,10 +1,17 @@
 {
   "default": true,
+  "MD003": { "style": "atx" }, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md003---heading-style
+  "MD004": { "style": "dash" }, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md004---unordered-list-style
+  "MD007": { "indent": 4 }, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md007---unordered-list-indentation
+  "MD009": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md009---trailing-spaces
+  "MD010": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md010---hard-tabs
   "MD013": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013---line-length
   "MD024": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md024---multiple-headings-with-the-same-content
   "MD025": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md025---multiple-top-level-headings-in-the-same-document
   "MD029": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md029---ordered-list-item-prefix
   "MD033": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033---inline-html
   "MD036": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md036---emphasis-used-instead-of-a-heading
-  "MD041": false // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md041---first-line-in-a-file-should-be-a-top-level-heading
+  "MD041": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md041---first-line-in-a-file-should-be-a-top-level-heading
+  "MD049": { "style": "asterisk" }, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md049---emphasis-style-should-be-consistent
+  "MD050": { "style": "asterisk" } // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md050---strong-style-should-be-consistent
 }

Makefile

@@ -138,16 +138,6 @@ go.sum: go.mod
 ###                              Documentation                              ###
 ###############################################################################
 
-update-swagger-docs: statik
-	$(BINDIR)/statik -src=docs/client/swagger-ui -dest=docs/client -f -m
-	@if [ -n "$(git status --porcelain)" ]; then \
-        echo "\033[91mSwagger docs are out of sync!!!\033[0m";\
-        exit 1;\
-    else \
-        echo "\033[92mSwagger docs are in sync\033[0m";\
-    fi
-.PHONY: update-swagger-docs
-
 godocs:
 	@echo "--> Wait a few seconds and visit http://localhost:6060/pkg/github.com/cosmos/cosmos-sdk/types"
 	godoc -http=:6060
@@ -292,10 +282,13 @@ format:
 .PHONY: format
 
 docs-lint:
-	markdownlint . --fix
+	markdownlint-cli2 "**.md"
+
+docs-lint-fix:
+	markdownlint-cli2-fix "**.md"
 
-docs-lint-changed:
-	./scripts/linting/lint-changed-md-files.sh
+docs-link-check:
+	find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check --config ./.github/workflows/link-check-config.json
 
 .PHONY: lint lint-fix lint-fix-changed docs-lint docs-lint-changed
 

docs/docs/01-ibc/09-roadmap.md

@@ -7,7 +7,7 @@ slug: /roadmap/roadmap
 
 # Roadmap ibc-go
 
-_Lastest update: June 23th, 2023_
+*Latest update: June 23th, 2023*
 
 This document endeavours to inform the wider IBC community about plans and priorities for work on ibc-go by the team at Interchain GmbH. It is intended to broadly inform all users of ibc-go, including developers and operators of IBC, relayer, chain and wallet applications.
 

docs/docs/05-migrations/10-v7-to-v8.md

@@ -84,8 +84,9 @@ TODO: <https://github.com/cosmos/ibc-go/pull/3505> (extra parameter added to tra
 ## IBC Apps
 
 TODO: 
-- https://github.com/cosmos/ibc-go/pull/3303
-- https://github.com/cosmos/ibc-go/pull/3967
+
+- <https://github.com/cosmos/ibc-go/pull/3303>
+- <https://github.com/cosmos/ibc-go/pull/3967>
 
 ## Relayers