Markdown links check: added comments

GoogleChrome · Sep 4, 2020 · 89a16a6 · 89a16a6
1 parent 5a4b672
commit 89a16a6
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/.github/workflows/check-md-links.yml b/.github/workflows/check-md-links.yml
@@ -12,16 +12,17 @@ jobs:
     steps:
       - uses: actions/checkout@master
       - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        # check all markdown files from /docs and subfolders
         with:
           use-quiet-mode: 'yes'
           use-verbose-mode: 'yes'
           config-file: 'markdown.links.config.json'
           folder-path: 'docs/'
       - uses: actions/checkout@master
       - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        # check all markdown files from root but ignore subfolders
         with:
           use-quiet-mode: 'yes'
           use-verbose-mode: 'yes'
           config-file: 'markdown.links.config.json'
           max-depth: 0
-          file-path: './readme.md'