Skip to content

ci(docs): fail the build on broken links and anchors #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
krassx merged 1 commit into from
Oct 8, 2026
Merged

ci(docs): fail the build on broken links and anchors #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@ const config: Config = {
baseUrl: '/',
trailingSlash: true,

onBrokenLinks: 'warn',
onBrokenAnchors: 'warn',
// Fail the build (and the PR check) on a dead internal link or #anchor instead of warning:
// with 'warn' a broken /sdk/... link reached production unnoticed. Old URLs that must keep working
// belong in the client-redirects list below, not in content.
onBrokenLinks: 'throw',
onBrokenAnchors: 'throw',

markdown: {
format: 'detect',
Expand Down
Loading