Fix a self-contradiction, two stale numbers, and dead citations in the docs - #18
Merged
Merged
Conversation
…e docs
README claimed the architecture is "identical" to production while a later section
in the same file says the five-source generalization is this repo's own — contradicted
itself. The gate-count claim ("thirteen of fifteen") was stale since two gates were added
by an earlier PR and never reflected here; the real count is 22 pure-code / 2 model-verdict,
verified by grepping the gate strings directly. PROVIDERS.md had two scenario counts that no
longer matched a live demo run. ADAPTERS.md described the ClickUp status fallback as checking
a type field it never reads, and contradicted itself about which Drive comment had a reply.
README/AGENTS.md cited "PRD §N" as if it were a followable reference, but that document never
ships in this repo. The "~40ms" demo timing was stale against a live measurement.
Verified every fix against the running code (live demo output, grep counts, tsc/lint/test)
rather than against the docs' own cross-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
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
Full adversarial fact-check of every markdown file in the repo root against the actual
source code (not against the docs' own cross-references), ahead of sharing this repo cold
with prospective clients. Fixes:
the same file says the five-source generalization is this repo's own — a direct
self-contradiction. Reworded to be consistent with the correct account.
was stale — two gates were added by an earlier PR and this was never updated. Verified
the real count by grepping every gate string: 22 pure-code, 2 model-verdict, 24 total.
The grep command is now inline so the number is self-verifying instead of another fact
that can silently drift.
demo run (checked by actually running both providers).
typefield the codenever reads (it matches on status name only), and separately contradicted itself about
which Drive comment carried a reply.
document never ships in this repo, so it's a dead end for any outside reader. Removed
the citation where the sentence didn't need it, and made AGENTS.md's quote self-contained
where it did.
Verification
npx tsc --noEmitcleannpm run lintcleannpm test— 1000/1000 passingnpm run demoandnpm run demo -- --provider anthropicboth run correctlyassumed from the doc's prior text