fix(server): exempt append-only log from broken-link reporting#683
Open
hannut wants to merge 1 commit into
Open
fix(server): exempt append-only log from broken-link reporting#683hannut wants to merge 1 commit into
hannut wants to merge 1 commit into
Conversation
An append-only audit trail legitimately references docs that were later moved or deleted, so a broken outbound link in log.md is expected history, not an authoring defect. Stop the write path re-surfacing the warning on every log append.
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.
Problem
An append-only audit log (
log.md) legitimately references docs that were later movedor deleted — a broken outbound link there is expected history, not an authoring defect.
Today the write path re-surfaces a broken-link warning on every log append, so the
Problems panel keeps flagging historical links that are working as intended.
Fix
Exempt documents whose basename is
logfrom broken-link reporting inpackages/server/src/backlink-index.ts. Alog.mdwith a[[missing]]reference nowreturns
brokenLinks: [], while a non-log doc with the same reference still flagsno-such-doc.Testing
backlink-index.test.tscovering the log-exempt vsnon-log-flagged behaviour.
backlink-index.test.ts: 95 passed.A changeset (
'@inkeep/open-knowledge': patch) is included.