Skip to content

docs: qualify tutorial claims and simplify wording - #210

Merged
jc-macdonald merged 2 commits into
mainfrom
docs/plain-language
Oct 19, 2026
Merged

jc-macdonald merged 2 commits into
mainfrom
docs/plain-language

Conversation

@jc-macdonald

Copy link
Copy Markdown
Collaborator

The introductions and worked guides used promotional comparisons, universal performance claims and statements that could imply a Pareto front or a second simulation phase establishes scientific validity. Replace these with concrete descriptions and results scoped to the evaluated configurations.

Simplify the README and documentation overview. Clarify Pareto dominance, distinguish predictive scores from calibration, remove unsupported timing and optimizer comparisons, and describe the monitoring model as a simplified observation model. Keep equations, algorithms and runnable examples unchanged.

Validation: just format, just check, just ci, just doctest and uv run mkdocs build --strict passed. The full suite has 883 passing tests with 95.25% coverage. No runtime, dependency or version change.

jc-macdonald and others added 2 commits October 19, 2026 12:33
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jc-macdonald
jc-macdonald merged commit ee0136b into main Oct 19, 2026
8 checks passed
@jc-macdonald
jc-macdonald deleted the docs/plain-language branch October 21, 2026 02:05
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