Skip to content

fix(docs-site): rewrite relative links in local synced files (fixes docs deploy on main) #182

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
afeezorobsco-cyber merged 1 commit into from
Oct 20, 2026
Merged

fix(docs-site): rewrite relative links in local synced files (fixes docs deploy on main) #182

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions ROADMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,3 +494,4 @@ roadmap. See each phase section below for status and issue links.
wire the remaining state changes. Tests: two new integration cases
asserting the audit rows (the accept's two events, the decline's one)
against the real `AuditEvent` table.
- 2026-10-20 — Docs site: `docs/site/scripts/sync-docs.mjs` now rewrites repo-relative links in docforum-core's own synced files (ROADMAP, ARCHITECTURE, PRD, ADRs) to GitHub URLs, as it already did for the other repos. #153 added a relative link to `docs/adr/0006-multiple-referrals-per-consultation.md` in ROADMAP.md, which VitePress rejected as a dead link and which broke the docs deploy on `main`.
6 changes: 4 additions & 2 deletions docs/site/scripts/sync-docs.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,14 @@ async function copyLocal(from, to) {
const src = path.join(CORE_ROOT, from);
const dest = path.join(SITE_ROOT, to);
await mkdir(path.dirname(dest), { recursive: true });
const content = await readFile(src, 'utf8');
// Local files get the same rewrite as remote ones: a repo-relative link
// (e.g. ROADMAP.md -> docs/adr/0006-...md) has no page in the site.
const content = rewriteRelativeLinks(await readFile(src, 'utf8'), 'docforum-core');
await writeFile(dest, content);
console.log(` synced (local) ${from} -> docs/site/${to}`);
}

// Synced READMEs link relative to their own repo root (./ROADMAP.md,
// Synced files link relative to their own repo root (./ROADMAP.md,
// docs/adr/foo.md, LICENSE, ...) — meaningless in the docs site's own
// structure. Rewrite anything that isn't already absolute (http/https)
// or a same-page anchor (#foo) to point at the real file on GitHub,
Expand Down
Loading