feat: add doc link checker (#1130)

Signed-off-by: Tianchu Zhao <[email protected]>

Makefile

@@ -227,17 +227,29 @@ endif
 
 /usr/local/bin/mkdocs:
 	$(PYTHON) -m pip install mkdocs==1.3.0 mkdocs_material==8.3.9 mkdocs-embed-external-markdown==2.3.0
+/usr/local/bin/lychee:
+ifeq (, $(shell which lychee))
+ifeq ($(shell uname),Darwin)
+	brew install lychee
+else
+	curl -sSfL https://github.com/lycheeverse/lychee/releases/download/v0.13.0/lychee-v0.13.0-$(shell uname -m)-unknown-linux-gnu.tar.gz | sudo tar xz -C /usr/local/bin/
+endif
+endif
 
 # docs
 
 .PHONY: docs
-docs: /usr/local/bin/mkdocs
+docs: /usr/local/bin/mkdocs docs-linkcheck
 	mkdocs build
 
 .PHONY: docs-serve
 docs-serve: docs
 	mkdocs serve
 
+.PHONY: docs-linkcheck
+docs-linkcheck: /usr/local/bin/lychee
+	lychee --exclude-path=CHANGELOG.md --exclude-mail *.md
+
 # pre-push checks
 
 .git/hooks/%: hack/git/hooks/%

SECURITY.md

@@ -18,4 +18,4 @@ Security vulnerabilities will be disclosed via [release notes](https://github.co
 
 ## Vulnerability Scanning
 
-See [static code analysis](docs/static-code-analysis.md).
+See [static code analysis](docs/development/static-code-analysis.md).