Skip to content

docs: add migration guide for 1.4#1533

Merged
rapids-bot[bot] merged 2 commits intoNVIDIA:release/1.4from
willkill07:wkk_migration-guide-1.4
Jan 31, 2026
Merged

docs: add migration guide for 1.4#1533
rapids-bot[bot] merged 2 commits intoNVIDIA:release/1.4from
willkill07:wkk_migration-guide-1.4

Conversation

@willkill07
Copy link
Member

@willkill07 willkill07 commented Jan 31, 2026

Description

  • Adds per-user functions to notable new features in README
  • Adds migration guide notes for the 1.4 release

Closes

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation
    • Added "Per-User Functions" documentation describing deferred instantiation and per-user stateful resources.
    • Published v1.4.0 migration guide covering namespace and naming changes, function group migrations, secret-handling guidance, API and model migration notes, packaging updates, and frontend/refactor guidance.

✏️ Tip: You can customize this high-level summary in your review settings.

Signed-off-by: Will Killian <wkillian@nvidia.com>
@willkill07 willkill07 self-assigned this Jan 31, 2026
@willkill07 willkill07 requested a review from a team as a code owner January 31, 2026 01:32
@willkill07 willkill07 added doc Improvements or additions to documentation non-breaking Non-breaking change labels Jan 31, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 31, 2026

Walkthrough

Added 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

Cohort / File(s) Summary
Documentation Updates
README.md, docs/source/resources/migration-guide.md
Inserted "Per-User Functions" documentation link and added a comprehensive v1.4.0 migration section covering namespaces, function-group naming, secret handling, Zep Cloud and LLM/embedder model changes, per-user instantiation notes, config field removals, frontend/package relocation, and packaging/dependency notes.

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add migration guide for 1.4' is concise, descriptive, uses imperative mood, and directly summarizes the main changes (migration guide additions) in the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

♻️ 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.
As per coding guidelines: “Version numbers are derived automatically by setuptools-scm; never hard-code them in code or docs.”

Signed-off-by: Will Killian <wkillian@nvidia.com>
@willkill07
Copy link
Member Author

/merge

@rapids-bot rapids-bot bot merged commit 412ac7f into NVIDIA:release/1.4 Jan 31, 2026
17 checks passed
@willkill07 willkill07 deleted the wkk_migration-guide-1.4 branch February 25, 2026 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants