Skip to content

fix(docs): repair broken links breaking the Pages deploy#145

Merged
arimxyer merged 1 commit into
mainfrom
fix/docs-pages-broken-links
Jul 2, 2026
Merged

fix(docs): repair broken links breaking the Pages deploy#145
arimxyer merged 1 commit into
mainfrom
fix/docs-pages-broken-links

Conversation

@arimxyer

@arimxyer arimxyer commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

Problem

The Deploy Docs to GitHub Pages workflow has failed on every push to main since 2026-07-01 (5+ consecutive failures) — so the live docs site is stale as of 2026-06-27 and none of the recent docs (agent guide, #137/#138, v0.19.0 CHANGELOG + filter reference) are published.

Root cause: the Hugo site uses contentDir: ../docs, and docs/05-operations/agent.md links to the unit templates with ../../packaging/.... Those paths resolve when browsing the repo on GitHub, but point outside the Hugo content root, so Hugo reports:

ERROR Broken internal link in 05-operations/agent.md: target '../../packaging/systemd/pass-cli-agent.service' not found
ERROR Broken internal link in 05-operations/agent.md: target '../../packaging/launchd/com.reyamira.pass-cli.agent.plist' not found
ERROR error building site: logged 2 error(s)

and exits 1.

Fix

Point both links at absolute github.com/reyamira/pass-cli/blob/main/... URLs. Absolute URLs aren't subject to Hugo's internal-link resolution, and they resolve correctly for site visitors (the packaging files live at the repo root, outside the published site). Verified these were the only two out-of-content-root links in docs/ (grep -rE '\]\(\.\./\.\./' docs/).

The Validate Hugo Build check on this PR runs the same Hugo build and will confirm the site builds. Once merged, the Pages deploy on main will succeed and publish the full docs backlog including v0.19.0.

🤖 Generated with Claude Code

The Hugo site (contentDir: ../docs) fails to build because
docs/05-operations/agent.md links to the systemd/launchd unit templates
with ../../packaging/... — paths that resolve when browsing the repo on
GitHub but point outside the Hugo content root, so Hugo reports "Broken
internal link" and exits 1. Every docs deploy since the agent ops guide
landed (2026-07-01) has failed, so the live site is stale.

Point both links at absolute github.com/reyamira/pass-cli/blob/main URLs,
which are not subject to internal-link resolution and resolve correctly
for site visitors.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014kVLjbUL4F4CkoA7RbMYy8
@arimxyer arimxyer merged commit 5260d14 into main Jul 2, 2026
11 checks passed
@arimxyer arimxyer deleted the fix/docs-pages-broken-links branch July 2, 2026 02:02
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