Fix broken docs anchors and fail the build on anchor drift - #99
Conversation
The heading in docs/vis/mdv-integration.mdx was reworded from "&" to "and" at some point, changing its slug to `#issue-56-channel-and-extension-apis`, but two links still pointed at the old `#issue-56-channel--extension-apis`. Update both. `onBrokenLinks` was already 'throw', so a bad path failed the build while a bad fragment only warned. Set `onBrokenAnchors: 'throw'` to close that gap — this class of drift now fails CI instead of scrolling past in the build log. The build passing with it enabled also confirms there are no other broken anchors in the site. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThe change corrects two Issue ChangesMDV anchor validation
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration. 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 |
What changed
Two links pointed at a stale heading slug in the vis docs:
docs/docs/vis/mdv-integration.mdx:104(same-page link)docs/docs/vis/mdv-release-checklist.mdx:237(cross-page link)Both used
#issue-56-channel--extension-apis, but the heading atmdv-integration.mdx:108reads## Issue #56 channel and extension APIsand slugifies to#issue-56-channel-and-extension-apis. The&→andrewording moved the slug and left the links behind.Also set
onBrokenAnchors: 'throw'indocs/docusaurus.config.ts.Why
The broken anchors were emitting a
Docusaurus found broken anchors!warning onmain— pre-existing, not from any feature branch.onBrokenLinkswas already'throw', so a bad path failed the build while a bad fragment only warned. That asymmetry is what let this drift sit unnoticed. TurningonBrokenAnchorsup to'throw'closes the gap, so heading renames that orphan a link fail CI instead of scrolling past in the build log.Notes for reviewers
onBrokenAnchors: 'throw'doubles as the verification here: the build passing with it on proves there are zero broken anchors site-wide, not just that these two were fixed.cd docs && pnpm build→[SUCCESS] Generated static files in "build"., no broken-anchor warning.pnpm buildindocs/fails in a clean checkout (Can't resolve '@spatialdata/vis') until the workspace packages are built. Run the rootpnpm buildfirst. Unrelated to this change.🤖 Generated with Claude Code
Summary by CodeRabbit
#56cross-reference links in the integration guide and release checklist.