docs: fix broken anchor, enforce anchor checking, document macOS build gotcha - #3272
Merged
Conversation
…d gotcha The firstWriteWins/lastWriteWins page linked ./#reduction-guarantees (itself) instead of ../#reduction-guarantees (the reduction-strategies overview page, where that heading actually lives). With the only broken anchor site-wide now fixed, flip onBrokenAnchors from warn to throw so future broken anchors fail CI instead of shipping silently. Also documents the pre-existing hubspot-real-time redirect collision: it only reproduces on macOS's case-insensitive filesystem and doesn't affect the Linux-based production build, so it's a local-dev note rather than a bug fix.
|
🚀 Preview deployed to https://docs.estuary.dev/pr-preview/pr-3272/ |
aeluce
approved these changes
Jul 29, 2026
aeluce
left a comment
aeluce
left a comment
Collaborator
There was a problem hiding this comment.
Agree that we should eventually fail builds with broken anchors. Would it make sense to start this practice with the separate docs repo? I believe we've held off previously so failing docs checks wouldn't hold up feature releases (though theoretically if we've squashed all the anchor issues for now… 🤞).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
firstwritewins-and-lastwritewins.mdlinked./#reduction-guarantees(itself) instead of the reduction-strategies overview page, where that heading lives. (Resolved via merge with master, which had since fixed the same link independently using an absolute path — that version is what's in the final diff.)onBrokenAnchorsfromwarntothrowindocusaurus.config.js, now that the only offender is fixed, so future broken anchors fail the build instead of shipping silently.hubspot-real-timeredirect/page collision insite/README.md: the redirect'sfrompath differs from the realHubSpot-real-timepage only by case, sonpm run buildfails on macOS's case-insensitive filesystem with "the redirect plugin is not supposed to override existing files." Confirmed this does not affect production (Linux CI is case-sensitive), so it's a local-dev note, not a code change.Why
Found while investigating stale-anchor feedback on #3094 — a heading rename there broke an anchor link silently since
onBrokenAnchorsonly warns. Verified locally that flipping it tothrowcatches that class of bug without any other backlog (confirmed via fullnpm run buildbefore and after).Testing
npm run buildlocally: only failure is the pre-existing hubspot-real-time macOS collision (unrelated, documented, not present in CI).reduction-guaranteesbroken anchor pattern in the docs tree.