Skip to content

docs: point the cross-repo reference links at the docs site - #342

Merged
adnaan merged 1 commit into
mainfrom
docs/fix-cross-repo-links
Aug 1, 2026
Merged

docs: point the cross-repo reference links at the docs site#342
adnaan merged 1 commit into
mainfrom
docs/fix-cross-repo-links

Conversation

@adnaan

@adnaan adnaan commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

The CLI guide's "For more information" list links two references that cannot resolve from this repo:

- [API Reference](../references/api-reference.md)
- [Template Support Matrix](../references/template-support-matrix.md)

From docs/guides/, ../ is docs/ — and lvt has no docs/references/ directory at all. Both documents describe the core library and live in livetemplate/livetemplate, so a relative path was never going to reach them from here.

Pointed at their rendered home on the docs site instead. That is stable across repo layout changes, and it is where someone reading a CLI guide actually wants to land — the rendered reference rather than raw markdown.

How it surfaced

The docs site mirrors this guide to /cli/. Its sync tool now resolves upstream-relative links when mirroring (livetemplate/docs#130), because they were previously shipped verbatim and 404'd for every reader of the site. Resolving these two faithfully produced lvt/blob/v0.2.0/docs/references/api-reference.md, a 404 — which is how the underlying mistake became visible. The links were equally broken before, just silently.

No behaviour change; documentation only.

🤖 Generated with Claude Code

https://claude.ai/code/session_01QzC2djPjPHkNJgPzFpMX7v

The CLI guide's "For more information" list linked
../references/api-reference.md and ../references/template-support-matrix.md.
Neither path exists in this repo — lvt has no docs/references/ directory at
all. Those references document the core library and live in
livetemplate/livetemplate, so a relative path was never going to reach them.

Pointed at their rendered home on the docs site instead, which is stable
across repo layout changes and is where a reader following a CLI guide
actually wants to land.

Surfaced by the docs site's sync tool, which now resolves upstream-relative
links when mirroring (livetemplate/docs#130) and turned these into 404s
rather than silently broken paths.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QzC2djPjPHkNJgPzFpMX7v
@claude

claude Bot commented Aug 1, 2026

Copy link
Copy Markdown

Reviewed. This is a small, low-risk documentation fix — looks good to merge.

Code quality / correctness

  • The fix correctly replaces two dead relative links (../references/api-reference.md, ../references/template-support-matrix.md) that could never resolve, since this repo has no docs/references/ directory and those docs actually live in livetemplate/livetemplate.
  • The new URLs (https://livetemplate.fly.dev/reference/api, https://livetemplate.fly.dev/reference/template-support-matrix) are consistent with the domain already used elsewhere in the repo (README.md, CHANGELOG.md), so this isn't introducing a new/unverified external host.

One thing worth double-checking before merge

  • I can't fetch external URLs from here, so I couldn't confirm the two new links actually resolve (as opposed to 404ing, per the PR description's own account of how the previous broken links were discovered). Worth a quick manual click-through on /reference/api and /reference/template-support-matrix on the docs site to make sure the paths match what the docs site actually serves.

Other categories

  • No functional/behavior change, no security concerns, and no test coverage needed — this is markdown-only.

Nice clear PR description explaining how the breakage was found (via the docs-site sync tool resolving upstream-relative links). No changes requested.

@adnaan
adnaan merged commit 5374b32 into main Aug 1, 2026
1 check passed
@adnaan
adnaan deleted the docs/fix-cross-repo-links branch August 1, 2026 17:00
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