Skip to content

docs: update for v0.5.0 additions + 0.5.0 CHANGELOG entry (#34) - #35

Merged
sipemu merged 1 commit into
mainfrom
docs/issue-34-v0.5-updates
May 28, 2026
Merged

docs: update for v0.5.0 additions + 0.5.0 CHANGELOG entry (#34)#35
sipemu merged 1 commit into
mainfrom
docs/issue-34-v0.5-updates

Conversation

@sipemu

@sipemu sipemu commented May 28, 2026

Copy link
Copy Markdown
Contributor

Closes #34. Brings the mkdocs site and CHANGELOG in line with everything that landed across PRs #20#33.

Docs site

  • `docs/api/regression/diagnostics.md` — full sweep, ~20 new entries grouped by category (multicollinearity, OLS residual battery, influence / leverage, GLM residuals, goodness of fit).
  • `docs/api/regression/linear.md` — added `huber`, `pls`.
  • `docs/api/regression/glm.md` — added `logistic_regression` (sklearn-style); top-of-page note explaining the `lambda_` kwarg now available on all GLM expressions.
  • `docs/api/regression/alm.md` — distribution table expanded from 13 to 25; documented `loss`, `link`, `role_trim`, `extra_parameter`.
  • `docs/api/regression/summary-predict.md` — added `quantile_summary`, `quantile_predict`, `isotonic_predict`, `lm_dynamic_predict`.
  • `docs/api/classes/linear.md` — added `Huber`, `PLS` class entries.
  • `docs/api/classes/glm.md` — added `LogisticRegression` class; documented `lambda_` on existing GLM classes.
  • `docs/api/outputs.md` — 10 new struct schemas copied from `src/expressions/regression.rs`.
  • `docs/index.md` + `docs/getting-started.md` — "Use from Rust" callout and a diagnostics quick tour.

Drive-by fixes

  • `docs/API_REFERENCE.md` and `docs/api/README.md` had broken `../README.md` links and a dead TOC anchor that blocked `mkdocs build --strict`. Pointed at the GitHub README and dropped the dead anchor.

CHANGELOG

  • Added a complete 0.5.0 section listing every Added / Changed item from the session with PR references.
  • Corrected the 0.4.0 entry's release date from 2025-01-17 to 2026-01-17 to match the published tag.

Verification

  • `mkdocs build --strict` passes (only the intentional "API_REFERENCE.md not in nav" info remains).
  • The `docs.yml` workflow auto-deploys to GH Pages on merge.

🤖 Generated with Claude Code

Bring the mkdocs site and CHANGELOG in line with everything that
landed across PRs #20#33.

docs/api/regression/diagnostics.md — full sweep adding ~20 new
entries grouped by category:
  - Multicollinearity: vif, generalized_vif, high_vif_predictors
  - OLS residual battery: standardized / studentized / externally
    studentized residuals, residual_outliers
  - Influence / leverage: leverage, cooks_distance, dffits,
    influential_cooks, influential_dffits, high_leverage_points
  - GLM residuals: pearson / deviance / working for logistic and
    poisson
  - Goodness of fit: pearson_chi_squared_logistic / _poisson

Other docs:
  - regression/linear.md: huber, pls
  - regression/glm.md: logistic_regression (sklearn-style); lambda_
    kwarg note on all GLM expressions
  - regression/alm.md: 25 distributions; loss/link/role_trim/
    extra_parameter kwargs
  - regression/summary-predict.md: quantile_summary, quantile_predict,
    isotonic_predict, lm_dynamic_predict
  - classes/linear.md: Huber, PLS classes
  - classes/glm.md: LogisticRegression; lambda_ on existing classes
  - outputs.md: 10 new struct schemas copied from
    src/expressions/regression.rs
  - index.md, getting-started.md: brief "Use from Rust" + diagnostics
    quick tour

Drive-by fixes:
  - docs/API_REFERENCE.md and docs/api/README.md had broken
    ../README.md links and a dead TOC anchor that blocked
    `mkdocs build --strict`.

CHANGELOG.md: new 0.5.0 section listing every Added / Changed item
above with PR references. Also corrected the 0.4.0 entry's release
date from 2025-01-17 to 2026-01-17 to match the published tag.

`mkdocs build --strict` passes (only the intentional API_REFERENCE.md
"not in nav" info remains).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@codecov

codecov Bot commented May 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@sipemu
sipemu merged commit aa4c602 into main May 28, 2026
18 checks passed
@sipemu
sipemu deleted the docs/issue-34-v0.5-updates branch May 28, 2026 18:12
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.

Update documentation site for v0.5.0 additions

1 participant