docs: add Scope box (what it does / does not verify) for launch readiness#19
Merged
Conversation
Sets expectations before a public launch: ref-verify is a conservative guard, not an oracle. Makes explicit that a non-ACCEPT verdict means "not auto-verifiable, check it yourself" — not "the citation is wrong" — and lists the out-of-scope cases (full-text/figure values, relational claims, abstract-withholding publishers, statistical metrics) so a non-ACCEPT result on a real claim does not read as the tool being broken. Adds a verdict-reading table. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Why
Before a public "go use it" announcement, the README needs to set expectations. The tool errs toward flagging, so a new user testing real citations will see
WARN/PARTIAL/UNVERIFIABLEoften. Without framing, that reads as "broken / flags everything." This section reframes a non-ACCEPTverdict as "not auto-verifiable — check it yourself," not "the citation is wrong."What
Adds a Scope section after What it catches with:
UNVERIFIABLE).ACCEPT/WARN/PARTIAL/UNVERIFIABLE/REJECTand what each actually means.Docs only. Pairs with the release bump (#18) and the false-PARTIAL fixes (#10/#16/#17) as the launch-readiness checklist.