Repository navigation
fix(docs-site): rewrite relative links in local synced files (fixes docs deploy on main) - #182
Merged
Merged
Conversation
#153 added a repo-relative link (docs/adr/0006-...md) to ROADMAP.md. The docs sync copies ROADMAP.md into the VitePress site verbatim, where that path has no page, so vitepress build failed its dead-link check and the docs deploy on main broke. Remote files already get their relative links rewritten to GitHub URLs; apply the same rewrite to local files. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
1 participant
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 changed
docs/site/scripts/sync-docs.mjs:copyLocal()now runsrewriteRelativeLinks(), the same functionfetchRemote()already uses, so repo-relative links in docforum-core's own synced files become GitHub URLs. Also adds a ROADMAP changelog line.Why
#153 added
[docs/adr/0006-multiple-referrals-per-consultation.md](docs/adr/...)toROADMAP.md. The docs sync copiesROADMAP.mdtoroadmap/core.mdverbatim, where that path doesn't exist, so the Deploy docs site workflow onmainfails:PR CI doesn't build the docs site, which is why #153 was green. Fixing the sync, rather than the one link, means the next contributor who writes a normal relative link won't break the deploy again.
Testing
Ran
npm ci && npm run buildindocs/siteon this branch: the build passes. Stashing the fix and rebuilding reproduces the exact dead-link failure above.Note (not fixed here)
There are two ADRs numbered 0006:
0006-multiple-referrals-per-consultation.mdand0006-prisma-7-driver-adapter.md. One should be renumbered in a separate change.Which ROADMAP.md item does this close/progress?
Changelog entry only.
🤖 Generated with Claude Code