Skip to content

ci: add dead link checker and fix broken docs links - #172

Merged
IzumiSy merged 4 commits into
tailor-platform:mainfrom
anukiransolur:check-dead-links
Apr 9, 2026
Merged

IzumiSy merged 4 commits into
tailor-platform:mainfrom
anukiransolur:check-dead-links

Conversation

@anukiransolur

Copy link
Copy Markdown
Contributor

Summary

  • Add lychee dead link checker workflow that runs on PRs touching docs/**/*.md
  • Fix 6 broken links in the docs that referenced a non-existent guides/ directory

Changes

New: .github/workflows/link-check.yaml

Adds a CI check using lycheeverse/lychee-action to catch dead links in docs/ on every PR. The
check scans all docs/**/*.md files and fails if any broken links are found.

Fixed: Dead links in docs/

All 6 broken links pointed to a guides/ directory that does not exist. Redirected to the correct API reference pages or removed where
self-referential:

File Fix
components/app-shell.md guides/internationalization → api/define-i18n-labels
components/sidebar-group.md guides/internationalization → api/define-i18n-labels
components/command-palette.md guides/guards-permissions → api/guards/overview
components/with-guard.md guides/guards-permissions → api/guards/overview
api/define-i18n-labels.md Removed self-referential link
api/guards/overview.md Removed self-referential link

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to change this file name to doc-check.yaml, because lint-check sounds a bit too wide, but this focuses on docs.

@IzumiSy
IzumiSy merged commit 16acb74 into tailor-platform:main Apr 9, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants