Skip to content

docs(enrichers): standardize the per-enricher chapter template (#28)#72

Open
Metbcy wants to merge 1 commit into
mainfrom
docs/enricher-template-28
Open

docs(enrichers): standardize the per-enricher chapter template (#28)#72
Metbcy wants to merge 1 commit into
mainfrom
docs/enricher-template-28

Conversation

@Metbcy

@Metbcy Metbcy commented Jun 27, 2026

Copy link
Copy Markdown
Owner

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:

  1. Why this signal
  2. Algorithm
  3. Threshold
  4. Output
  5. Network
  6. Disabling
  7. Calibration
  8. See also

Chapters touched

typosquat.md, osv-cve.md, version-jump.md, maintainer-age.md, epss.md, kev.md, registry.md, plus a one-line overview.md fix.

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.md listed version-jump's calibration as a hard-coded MIN_MAJOR_DELTA = 2. That is stale: the value is tunable via --multi-major-delta <N> (v0.9.7, default 2). Verified against src/cli.rs (the multi_major_delta field) and src/enrich/version_jump.rs (enrich_with reads the flag, falling back to MIN_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 links
  • Section audit: all seven chapters carry the eight canonical headings in identical order

Docs only, no .rs changes.

Closes #28.

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.
@github-actions

Copy link
Copy Markdown

Coverage report

Line 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; --fail-under-lines will be added once coverage is visible across 2–3 releases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standardize the per-enricher docs chapter template

1 participant