fix: repair broken doc links and make them fail the build - #117
Conversation
Two links pointed at docs/dashboards/overview, which was deleted in f24aa81 ("adding alerts") along with saving-views.md and service-menu.md. The references were left behind, so both have been dead ever since: docs/providers-services/overview.md:74 docs/providers-services/services/add-services.md:36 Retargeted to dashboards/saved-dashboards, the only page left in that section and the one the sidebar lists. The reason this survived is that onBrokenLinks was 'warn', so Docusaurus printed the problem and exited 0 -- invisible in build output and invisible to CI. Set it to 'throw'. Verified the gate works by pointing a link at a nonexistent page and confirming the build fails. Note this is a different check from the link-check workflow, which validates external URLs in markdown; neither caught these internal route links. Also moved onBrokenMarkdownLinks under markdown.hooks, where Docusaurus 3.10 wants it -- it was warning on every build that v4 will remove the top-level option. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Review limit reached
Next review available in: 39 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
1 participant
The broken links
Two links point at
docs/dashboards/overview, which doesn't exist — it was deleted in f24aa81 ("adding alerts"), along withsaving-views.mdandservice-menu.md. The references were never updated, so both have been dead since:docs/providers-services/overview.mddocs/providers-services/services/add-services.mdBoth are in Getting Started / Next Steps sections — the paths a new user is most likely to follow.
Retargeted to
dashboards/saved-dashboards, the only page left in that section and the onesidebars.jslists.Why nobody noticed
onBrokenLinkswas set to'warn'. Docusaurus printed the problem and exited 0 — so it scrolled past in build output and no CI signal existed. This PR sets it to'throw'.I verified the gate actually works rather than assuming: pointed a link at a nonexistent page, confirmed the build fails with
Docusaurus found broken links!, then reverted.Worth being clear that this is a different check from the
link-checkworkflow — that one validates external URLs in markdown files. Neither caught these, because they're internal route links resolved by Docusaurus. Now one of them does.Also: deprecation warning
onBrokenMarkdownLinksmoved undermarkdown.hooks, where Docusaurus 3.10 expects it. It was printing a deprecation warning on every build about v4 removing the top-level option.Verification
Build passes clean — no broken links, no deprecation warnings.
🤖 Generated with Claude Code