@@ -326,3 +326,33 @@ dependencies. May show additional ghc boot libraries.
326326```
327327$ nix-shell --run "ghc-pkg dot | dot -Tpdf > streamly.pdf"
328328```
329+
330+## Checking for broken links in the markdown files
331+
332+You can use [markdown-link-check](https://github.com/tcort/markdown-link-check)
333+for finding broken links.
334+
335+You can run it using `npx` like so:
336+```
337+npx markdown-link-check <markdown-file>
338+```
339+
340+The following command - when run from the repository root - finds all the
341+markdown files that we need to consider:
342+
343+```
344+find . -type f -name "*.md" \
345+ -not -path "./dist*" \
346+ -not -path "./.stack*" \
347+ -not -path "./benchmark/bench-report/dist*"
348+```
349+
350+The following executes the markdown link checking on the results:
351+
352+```
353+find . -type f -name "*.md" \
354+ -not -path "./dist*" \
355+ -not -path "./.stack*" \
356+ -not -path "./benchmark/bench-report/dist*" \
357+ -exec npx markdown-link-check --quiet {} \;
358+```