docs: fix 12 broken internal links (relative-path drift)#265
Merged
Destynova2 merged 1 commit intomainfrom Apr 25, 2026
Merged
Conversation
Validated locally with `lychee --offline --include-fragments docs/**/*.md
README.md CLAUDE.md` (0 errors after fix, was 12).
Three recurring patterns:
1. Doubled subdirectory in relative links (resolves to nonexistent
`docs/how-to/how-to/...`, `docs/reference/reference/...`):
- docs/how-to/providers.md: oauth-setup.md, gemini-integration.md
- docs/reference/configuration.md: dlp.md
- docs/reference/openai-compatibility.md: api-compatibility.md
- docs/reference/responses-api-compatibility.md: api-compatibility.md
2. Missing parent traversal (link from one Diataxis category to another
without `../`):
- docs/tutorials/quickstart.md: 4 next-step links
- docs/reference/configuration.md: ADR-0005 link
3. Stale or out-of-tree references:
- docs/how-to/auto-tune-routing.md: removed link to
docs/explanation/complexity-scoring.md (file was never created).
- docs/decisions/0018-nature-inspired-routing.md: unlinked two
internal Obsidian-vault references (path was absolute to the
author's machine, never resolvable in CI). Text retained as
non-hyperlinked references.
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
1 participant
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.
Summary
Final cleanup follow-up to #261/#263/#264. Validated locally with
lychee --offline --include-fragments docs/**/*.md README.md CLAUDE.md(0 errors after fix, was 12).Three recurring patterns:
Doubled subdirectory in relative links (e.g.
how-to/oauth-setup.mdwritten from insidedocs/how-to/→ resolves todocs/how-to/how-to/oauth-setup.md):docs/how-to/providers.md(oauth-setup, gemini-integration)docs/reference/configuration.md(dlp)docs/reference/openai-compatibility.md(api-compatibility)docs/reference/responses-api-compatibility.md(api-compatibility)Missing parent traversal (link from one Diátaxis category to another without
../):docs/tutorials/quickstart.md(4 next-step links to explanation/, how-to/, reference/, openapi.yaml)docs/reference/configuration.md(ADR-0005 link)Stale or out-of-tree references:
docs/how-to/auto-tune-routing.md: removed link todocs/explanation/complexity-scoring.md(file was never created).docs/decisions/0018-nature-inspired-routing.md: unlinked two internal Obsidian-vault references (path was absolute to the author's machine, never resolvable in CI). Text retained as non-hyperlinked references.Test plan
lychee --offline --include-fragments docs/**/*.md README.md CLAUDE.md→0 ErrorsBroken link check (lychee)finally green onmain