docs(readme): correct two claims the code does not back - #22
Merged
Conversation
Two present-tense statements described behavior that is not implemented: - Product Philosophy #3 said "Stale and low-signal events are filtered." Time/age-based stale filtering does not exist — classify only does recent-window burst detection (countBurst / DEFAULT_BURST_THRESHOLD), and the roadmap itself lists the "stale-noise (time-based) gate" as pending. Reworded to "Low-signal noise is suppressed and true burst behavior is surfaced early" so the principle matches reality (and the roadmap). - Input Model listed "error payload and stack hints", but runtimeError in the v2 schema exposes only { type, message, status, code, retryable } with additionalProperties:false — a stack field would be rejected by validation. Dropped "and stack hints". Co-Authored-By: Claude Opus 4.8 <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.
Two present-tense README statements described behavior that isn't implemented. Verified against the code/schema:
1. Product Philosophy #3 — "Stale and low-signal events are filtered" (factually wrong + self-contradictory)
Time/age-based stale filtering does not exist.
packages/classify/src/index.tsonly does recent-window burst detection (countBurst,DEFAULT_BURST_THRESHOLD = 3); there is noDate.now/age logic anywhere inpackages/*/src. The README's own Roadmap already lists the "stale-noise (time-based) gate" as pending.→ Reworded to "Low-signal noise is suppressed and true burst behavior is surfaced early."
2. Input Model — "error payload and stack hints" (no such field)
runtimeErrorinschemas/runtime-event.v2.jsondefines exactly{ type, message, status, code, retryable }withadditionalProperties: false, matchingRuntimeErrorinpackages/core/src/index.ts. Astackpayload would be rejected by schema validation.→ Dropped "and stack hints".
Docs-only; no code or schema change.