docs(enrichers): standardize the per-enricher chapter template (#28)#72
Open
Metbcy wants to merge 1 commit into
Open
docs(enrichers): standardize the per-enricher chapter template (#28)#72Metbcy wants to merge 1 commit into
Metbcy wants to merge 1 commit into
Conversation
The seven per-enricher chapters grew organically with inconsistent section headings. Restructure all of them to the same eight-section shape in the same order: Why this signal, Algorithm, Threshold, Output, Network, Disabling, Calibration, See also. Content is reorganized, not rewritten: existing prose moves under the canonical headings, with N/A notes where a signal genuinely lacks an aspect (the pure-compute typosquat and version-jump signals have no network and no opt-out flag). Also fixes a stale overview.md row: version-jump's calibration is the --multi-major-delta flag (v0.9.7, default 2), not a hard-coded constant. Verified against src/cli.rs and src/enrich/version_jump.rs. Closes #28.
Coverage reportLine coverage: 83.6% (9179 / 10976 lines) Full lcov report available as workflow artifact coverage-lcov: download from this run. v0.9.8 introduces this report; |
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
Restructures the seven per-enricher doc chapters under
docs/src/enrichers/to a single eight-section template, in the same order across every chapter. Closes #28.The content is reorganized, not rewritten: existing prose moves under the canonical headings.
The template
Every chapter now has these sections in this order:
Chapters touched
typosquat.md,osv-cve.md,version-jump.md,maintainer-age.md,epss.md,kev.md,registry.md, plus a one-lineoverview.mdfix.Sections that genuinely do not apply carry an N/A note rather than an invented fact. The pure-compute signals (typosquat, version-jump) state that they never touch the network and have no
--no-*flag, pointing instead at the knob that does control them.Overview fix
overview.mdlisted version-jump's calibration as a hard-codedMIN_MAJOR_DELTA = 2. That is stale: the value is tunable via--multi-major-delta <N>(v0.9.7, default 2). Verified againstsrc/cli.rs(themulti_major_deltafield) andsrc/enrich/version_jump.rs(enrich_withreads the flag, falling back toMIN_MAJOR_DELTA). Corrected the row to match the source and the six other docs that already document the flag.Testing
mdbook build: clean, no broken linksDocs only, no
.rschanges.Closes #28.