minor doc

.github/workflows/build-deploy-docs.yml

@@ -15,7 +15,12 @@ jobs:
       - uses: actions/checkout@v4
       - uses: Swatinem/rust-cache@v2
 
-      - name: Run link check
+      - name: 'Validate .md files (use "just fmt-md" to fix)'
+        uses: DavidAnson/markdownlint-cli2-action@v14
+        with:
+          config: '.github/files/config.markdownlint-cli2.jsonc'
+
+      - name: 'Check Markdown URLs (same as "just clippy-md")'
         uses: gaurav-nelson/github-action-markdown-link-check@v1
         with:
           use-quiet-mode: 'no'
@@ -24,11 +29,6 @@ jobs:
           file-path: './README.md'
           config-file: '.github/files/markdown.links.config.json'
 
-      - name: Markdown lint
-        uses: DavidAnson/markdownlint-cli2-action@v14
-        with:
-          config: '.github/files/config.markdownlint-cli2.jsonc'
-
       - name: Setup mdBook
         uses: peaceiris/actions-mdbook@v1
         with:

justfile

@@ -273,8 +273,8 @@ clippy:
 
 # Run markdown links checking
 clippy-md:
-    @echo "Running markdown-link-check to validate "
-    docker run -it --rm -v ${PWD}:/workdir --entrypoint sh ghcr.io/tcort/markdown-link-check -c 'echo -e "/workdir/README.md\n$(find /workdir/docs/src -name "*.md")"|tr "\n" "\0" | xargs -0 -P 5 -n1 -I{} markdown-link-check --config /workdir/.github/files/markdown.links.config.json {}'
+    @echo "Running markdown-link-check to validate URLs in the .md files"
+    docker run -it --rm -v ${PWD}:/workdir --entrypoint sh ghcr.io/tcort/markdown-link-check -c 'echo -e "/workdir/README.md\n$(find /workdir/docs/src -name "*.md")" | tr "\n" "\0" | xargs -0 -P 5 -n1 -I{} markdown-link-check --config /workdir/.github/files/markdown.links.config.json {}'
 
 # These steps automatically run before git push via a git hook
 [private]