docs: add migration guide for 1.4#1533
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
WalkthroughAdded two documentation entries: a "Per-User Functions" item in README and a new v1.4.0 "Version Specific Changes" section in the migration guide detailing migration notes and configuration/namespace updates. No code or API behavior changes. Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Line 52: Add a user-facing changelog entry for the new "Per-User Functions"
feature to CHANGELOG.md: locate the current release section where user-visible
features are documented (e.g., the "Unreleased" or the matching version heading)
and add a short bullet noting "Per-User Functions: NeMo Agent Toolkit now
supports per-user functions for deferred instantiation, enabling per-user
stateful functions, per-user resources, and other features" so the README change
is reflected in the project changelog.
🧹 Nitpick comments (1)
docs/source/resources/migration-guide.md (1)
30-111: Avoid hard-coded version numbers in docs.This new block hard-codes versions (e.g., “v1.4.0”, “v3”, “3.0”), which conflicts with the guideline that version numbers must not be hard-coded in documentation. Please rephrase to avoid explicit version strings or use a docs substitution/variable if available.
As per coding guidelines: “Version numbers are derived automatically by setuptools-scm; never hard-code them in code or docs.”♻️ Possible rewrite approach
-### v1.4.0 +### Current release -#### Zep Cloud v3 Migration +#### Zep Cloud major-version migration -- Upgrade your dependency to `zep-cloud~=3.0`. +- Upgrade your dependency to the latest supported `zep-cloud` major release.
Signed-off-by: Will Killian <wkillian@nvidia.com>
|
/merge |
Description
Closes
By Submitting this PR I confirm:
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.