Upgrade guide - #476
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The new upgrade guide includes copy-pastable PHP examples and statements that are currently inconsistent with the library API defaults/signatures.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds a dedicated upgrade guide to the documentation site to help users migrate from Rubix ML 2.0 to 3.0, and links it from the MkDocs navigation.
Changes:
- Added a new “Upgrading from 2.0 to 3.0” guide covering breaking changes, behavioral changes, and new features.
- Linked the new guide from the “Getting Started” section in
mkdocs.yml. - Removed a changelog bullet entry (“Emoji preset to Regex Filter”).
File summaries
| File | Description |
|---|---|
| mkdocs.yml | Adds the Upgrade Guide page to the documentation navigation. |
| docs/upgrading-to-3.md | New upgrade guide content for migrating from 2.0 → 3.0. |
| CHANGELOG.md | Removes one bullet entry from the v3.0 changelog section. |
Review details
Suppressed comments (1)
docs/upgrading-to-3.md:328
- Pipeline's constructor expects the first argument to be an array of transformers, but this example passes a single transformer instance, which would throw a TypeError if copied verbatim.
// or inside a pipeline
$estimator = new Pipeline(new FloatTypeConverter(), new KMeans(5));
- Files reviewed: 3/3 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.