docs: point the cross-repo reference links at the docs site - #342
Merged
Conversation
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
|
Reviewed. This is a small, low-risk documentation fix — looks good to merge. Code quality / correctness
One thing worth double-checking before merge
Other categories
Nice clear PR description explaining how the breakage was found (via the docs-site sync tool resolving upstream-relative links). No changes requested. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The CLI guide's "For more information" list links two references that cannot resolve from this repo:
From
docs/guides/,../isdocs/— andlvthas nodocs/references/directory at all. Both documents describe the core library and live inlivetemplate/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 producedlvt/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