Skip to content

fix(docs): repair broken links failing Deploy Documentation CI#3103

Merged
maphew merged 1 commit into
gastownhall:mainfrom
maphew:fix/broken-doc-links
Apr 7, 2026
Merged

fix(docs): repair broken links failing Deploy Documentation CI#3103
maphew merged 1 commit into
gastownhall:mainfrom
maphew:fix/broken-doc-links

Conversation

@maphew

@maphew maphew commented Apr 7, 2026

Copy link
Copy Markdown
Collaborator

Problem

The Deploy Documentation workflow is failing on every push to main. Two root causes:

1. Broken Docusaurus links (4 links → 6 files)

Pages link to targets that don't exist:

  • /docs/DOLT.md and /docs/CONFIG.md — repo-level files, not Docusaurus pages
  • /core-concepts/dolt-server and /core-concepts/dolt-sync — pages that were never created

2. Lychee link checker vs baseUrl: /beads/

All internal navigation links use the /beads/ prefix (required for GitHub Pages), but lychee resolves them against website/build/ which doesn't have a beads/ subdirectory — causing every single internal link to fail.

Fix

  • architecture/index.md: /docs/DOLT.md#dolt-server-mode anchor (content already on-page)
  • core-concepts/index.md: /core-concepts/dolt-server and /dolt-sync → same-page anchor links
  • reference/configuration.md: /docs/CONFIG.md → GitHub source URL
  • versioned_docs/version-1.0.0: same fixes applied
  • deploy-docs.yml: added --remap '/beads/(.*) /$1' to strip baseUrl prefix for lychee resolution

Testing

All broken link patterns eliminated:

grep -rn 'docs/DOLT.md\|docs/CONFIG.md\|core-concepts/dolt-server\|core-concepts/dolt-sync' website/docs/ website/versioned_docs/
# (no output)

- architecture/index.md: /docs/DOLT.md → #dolt-server-mode anchor
- core-concepts/index.md: /core-concepts/dolt-server and /dolt-sync → anchor links (pages never existed)
- reference/configuration.md: /docs/CONFIG.md → GitHub source link
- deploy-docs.yml: add lychee --remap to strip /beads/ baseUrl prefix from internal links
- Apply same fixes to versioned_docs/version-1.0.0/

Amp-Thread-ID: https://ampcode.com/threads/T-019d68c4-3efa-71bf-aa9d-6e25fc48fb9a
Co-authored-by: Amp <amp@ampcode.com>
@maphew maphew merged commit 7fe590d into gastownhall:main Apr 7, 2026
31 checks passed
seanmartinsmith pushed a commit to seanmartinsmith/beads that referenced this pull request Apr 10, 2026
…wnhall#3103)

- architecture/index.md: /docs/DOLT.md → #dolt-server-mode anchor
- core-concepts/index.md: /core-concepts/dolt-server and /dolt-sync → anchor links (pages never existed)
- reference/configuration.md: /docs/CONFIG.md → GitHub source link
- deploy-docs.yml: add lychee --remap to strip /beads/ baseUrl prefix from internal links
- Apply same fixes to versioned_docs/version-1.0.0/

Amp-Thread-ID: https://ampcode.com/threads/T-019d68c4-3efa-71bf-aa9d-6e25fc48fb9a

Co-authored-by: Amp <amp@ampcode.com>
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