Skip to content

Commit 42fe00d

Browse files
chmouelchmouel
committed
feat: overhaul README and add link checker
Updated the README to use a concise layout with better navigation and organized content that links to the documentation. Added a link-checking step to the Makefile to ensure documentation links remain valid. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
1 parent 78232e2 commit 42fe00d

2 files changed

Lines changed: 61 additions & 381 deletions

File tree

‎Makefile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,9 @@ download-htmltest: ## Download htmltest binary
206206

207207
.PHONY: check-links
208208
check-links: ## Check documentation links (set CHECK_EXTERNAL=false to skip external URLs)
209+
@echo "Checking README links..."
210+
@grep -oP 'https://[^\s)>]+' README.md | xargs -I{} -P5 sh -c 'code=$$(curl -s -o /dev/null -w "%{http_code}" -L --max-time 5 "{}"); printf "%s %s\n" "$$code" "{}"; case "$$code" in 2*) exit 0;; *) exit 1;; esac'
211+
@echo "Checking documentation links..."
209212
./hack/check-links.sh
210213

211214
.PHONY: fix-links

0 commit comments

Comments
 (0)