Skip to content

fix(docs): prefix internal links with site base, repair broken targets#81

Merged
vazra merged 1 commit into
mainfrom
fix/docs-site-base-url-links
Apr 30, 2026
Merged

fix(docs): prefix internal links with site base, repair broken targets#81
vazra merged 1 commit into
mainfrom
fix/docs-site-base-url-links

Conversation

@vazra
Copy link
Copy Markdown
Owner

@vazra vazra commented Apr 30, 2026

Summary

  • Add remark plugin that prefixes absolute internal links with the site base (/simpledeploy) at build time, fixing 404s for hero CTAs, LinkCards, and inline markdown links across the docs site.
  • Repair 11 stale link targets (users-roles flatten, backups index missing, /trust runtime route) surfaced by starlight-links-validator.
  • Exclude blog index (generated by starlight-blog) and localhost dev URLs from validator false-positives.

Test plan

  • pnpm build in docs-site/ reports 0 invalid links
  • Spot-check rendered dist/index.html shows internal hrefs prefixed with /simpledeploy/
  • After merge, verify https://vazra.github.io/simpledeploy/ hero + LinkCards navigate without 404

Internal absolute links in markdown were not getting the /simpledeploy
base prefix, 404ing on GitHub Pages. Add a remark plugin that rewrites
absolute internal URLs and JSX href/src/link attrs at build time. Hero
frontmatter patched directly since remark skips frontmatter.

Also fix stale link targets surfaced by the link validator:
- /guides/users/roles/ -> /guides/users-roles/
- /guides/backups/ -> /guides/backups/overview/
- /simpledeploy/concepts/backups/ -> /guides/backups/overview/
- /trust -> inline note (runtime route, not a docs page)

Exclude blog index and localhost dev URLs from the validator.
@vazra vazra merged commit 0d0faf4 into main Apr 30, 2026
4 of 5 checks passed
@vazra vazra deleted the fix/docs-site-base-url-links branch April 30, 2026 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant