Skip to content

Update README + docs landing for recent releases#465

Merged
kgdunn merged 8 commits into
mainfrom
claude/repo-changelog-marketing-47ij39
Jul 21, 2026
Merged

Update README + docs landing for recent releases#465
kgdunn merged 8 commits into
mainfrom
claude/repo-changelog-marketing-47ij39

Conversation

@kgdunn

@kgdunn kgdunn commented Jul 21, 2026

Copy link
Copy Markdown
Owner

Summary

Update the front-facing docs so they catch up with the last few weeks of releases (through v1.55.0) and read in a way that makes a prospective user want to try the package right away.

  • README: new "What's new" section; expanded feature list and comparison table (adaptive/on-line monitoring, OMARS & optimal DOE); new runnable quick-start snippets for AdaptivePCA on-line monitoring and for OMARS / D-optimal designs.
  • Softened the scikit-learn framing from an adversarial "Why not scikit-learn?" to a complementary "Works alongside scikit-learn", per maintainer preference.
  • Removed the factori.al references.
  • Dropped the in-memory/scaling caveat callout from the README front page.
  • Wording: reserve "batch" for the batch-process data sense used elsewhere in the repo; the adaptive-model context now uses "static"/"initial"/"offline" instead.
  • Docs landing/quickstart updated to mirror the new highlights.
  • Version bumped to 1.55.1 with a matching CITATION.cff update and a CHANGELOG.md Documentation entry.

Test plan

  • New README/quickstart snippets were executed against the real API: AdaptivePCA().fit().update(), AdaptivePLS().fit(), generate_design(..., design_type="omars"/"d_optimal"), and evaluate_design(..., metric="all") all run.
  • No em-dashes introduced in the edited docs.
  • pyproject.toml and CITATION.cff report the same version.

Checklist

  • Version bumped in pyproject.toml (PATCH for docs)
  • Tests added or updated where relevant (docs-only change; not applicable)
  • ruff check . passes
  • CHANGELOG.md updated

🤖 Generated with Claude Code

https://claude.ai/code/session_01X762hoccCvqtJuDgwUf6BH

claude added 5 commits July 21, 2026 05:01
…ry; soften sklearn framing

Refresh the front page for recent releases: add a What's new section and
new quick-start snippets for on-line monitoring with AdaptivePCA and for
OMARS / D-optimal designs. Reframe the scikit-learn section as complementary
rather than adversarial, and remove the dead factori.al references.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01X762hoccCvqtJuDgwUf6BH
…ckstart; refresh landing intro

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01X762hoccCvqtJuDgwUf6BH
Documentation-only release: front-page and docs-landing marketing refresh.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01X762hoccCvqtJuDgwUf6BH
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01X762hoccCvqtJuDgwUf6BH
Reserve 'batch' for the batch-process data sense used elsewhere in the repo;
use 'static'/'initial'/'offline' for the adaptive-model context instead.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01X762hoccCvqtJuDgwUf6BH
@kgdunn kgdunn changed the title Marketing refresh: README + docs landing for recent releases Update README + docs landing for recent releases Jul 21, 2026
@kgdunn
kgdunn merged commit a2c2172 into main Jul 21, 2026
13 checks passed
@kgdunn
kgdunn deleted the claude/repo-changelog-marketing-47ij39 branch July 21, 2026 05:24
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.

2 participants