Skip to content

docs: document SPC methods and Grubbs' test in module overviews#113

Merged
devcrocod merged 1 commit intomasterfrom
docs/spc-and-grubbs-overview
Apr 23, 2026
Merged

docs: document SPC methods and Grubbs' test in module overviews#113
devcrocod merged 1 commit intomasterfrom
docs/spc-and-grubbs-overview

Conversation

@devcrocod
Copy link
Copy Markdown
Member

Description

Extend kstats-core and kstats-hypothesis module overviews with user
documentation for the recently implemented SPC methods (process capability,
Shewhart x̄-R/S, CUSUM, EWMA, Western Electric Rules) and the Grubbs
outlier test. Each section has intuition, formula (in an Accordion),
a Korro-linked example, and tuning guidance. German translations mirrored
in docs/de. Also fixes four stale /getting-started/quick-start links
(page was renamed to /quickstart).

Refs: #34, #35, #36, #37, #38, #65

Testing

./gradlew :kstats-core:jvmTest :kstats-hypothesis:jvmTest korro +
mint validate and mint broken-links in docs/.

Checklist

  • Existing tests pass
  • New/updated tests for changed behavior
  • New/updated documentation if necessary

Extend kstats-core and kstats-hypothesis module overviews with user
documentation for recently added statistical process control methods
and the Grubbs outlier test.

- core/overview: Process Capability (Cp, Cpk, Pp, Ppk), Shewhart x-bar
  R/S charts, CUSUM, EWMA, and Western Electric Rules — each with
  intuition, formula, Korro-linked example, and tuning guidance.
- hypothesis/overview: Grubbs' test section with two-sided, one-sided
  (GREATER/LESS), and iterative variants.
- Korro samples in both core and hypothesis DocsSamples for all new
  sections, with values from existing unit tests.
- Translations mirrored in docs/de.
- Fix stale /getting-started/quick-start links to /quickstart
  (page was renamed earlier; broken-links check flagged them).

Refs: #34, #35, #36, #37, #38, #65
@devcrocod devcrocod merged commit 1b0765a into master Apr 23, 2026
3 checks passed
@devcrocod devcrocod deleted the docs/spc-and-grubbs-overview branch April 23, 2026 22:26
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.

1 participant