docs: correct stale detection rule and scenario counts#119
Merged
Conversation
Both READMEs advertised 10 detection rules and 10 predefined scenarios. The source has shipped 16 rules and 15 scenarios since 0.3.1: the FailureCode union carries 16 codes, split 4 critical / 10 warning / 2 info by the SEVERITY map, and detectFailures() composes 16 detect calls. The scenario registry exports 15, pinned by an existing test. packages/toolkit/README.md is the README npm renders on the package page, so the stale counts were the first thing anyone evaluating the library read. The root README carried the same two lines. Also corrects CURRENT_STATE.md, which reported 0.3.0 as the current version while npm latest has been 0.3.1 since 2026-07-09. The v0.3 milestone record keeps its historical "15 detection rules" note, since that was accurate for v0.3.0; the 16th rule shipped in 0.3.1.
The npm package page renders the README from the published tarball, so the corrected counts only reach npm on the next publish. Cut a patch release rather than waiting for the next feature to carry them.
sepehr-safari
added
type:docs
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
Both READMEs advertised "10 detection rules" and "10 predefined scenarios". The
toolkit has shipped 16 rules and 15 scenarios since 0.3.1, so the docs undersold
the project on the page most people read first.
packages/toolkit/README.md(the README npm renders on the package page):10 -> 16 rules, 10 -> 15 scenarios.
README.md(repo landing page): same two lines.CURRENT_STATE.md: current version 0.3.0 -> 0.3.1, package status table0.3.0 -> 0.3.1, plus a v0.3.1 release record.
Closes #118
Verified against source, not prose
FailureCodeunion,types.tsSEVERITYmap,detection.tsdetectFailures(),detection.tsdetect*callsscenariosregistry,scenarios/index.tsexports exactly 15 scenariostestThe 16 rule names listed in the README map 1:1 onto the
FailureCodeunion, inthe same order. The 16th rule (
REPEATED_BOOT_NOTIFICATION) landed in #114 andshipped in 0.3.1; both READMEs predate it.
Why the changeset
The npm package page renders the README from the published tarball, so merging
alone does not correct npm. #113's repo-rename README fix carried no changeset
and only reached npm when #114 bumped to 0.3.1 and republished. Since v1.0.0 is
the next milestone and no feature release is queued, the corrected counts would
sit unpublished indefinitely. The patch changeset cuts 0.3.2 so the npm page
actually updates.
Deliberately unchanged
The v0.3 milestone blurb in
CURRENT_STATE.mdstill records "15 detectionrules" for v0.3.0. That was accurate for that release, and the 16th rule shipped
in 0.3.1, so it stays as history. Only the current-version fields moved.
Checks
pnpm format:checkcleanpnpm lintcleanpnpm test374 passing across 16 files