Skip to content

Update documentation to reflect dependency pinning for NeMo Agent Toolkit#151

Merged
AjayThorve merged 1 commit intoNVIDIA-AI-Blueprints:developfrom
AjayThorve:update-docs1
Mar 14, 2026
Merged

Update documentation to reflect dependency pinning for NeMo Agent Toolkit#151
AjayThorve merged 1 commit intoNVIDIA-AI-Blueprints:developfrom
AjayThorve:update-docs1

Conversation

@AjayThorve
Copy link
Collaborator

No description provided.

…lkit (NAT) v1.4.0; clarify that NAT v1.5 or later is not supported in this release.
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 14, 2026

Greptile Summary

This PR is a documentation-only update that adds a prominent dependency warning across the project's key entry points, notifying users that AI-Q is pinned to NeMo Agent Toolkit (NAT) v1.4.0 (nvidia-nat==1.4.0) and that upgrading to v1.5 or later is not yet supported. The warning appears in both README.md and docs/source/get-started/installation.md as a blockquote note, and a matching changelog entry is added to docs/source/resources/changelog.md under v2.0.1 (In Development). The .secrets.baseline file is updated to reflect the shifted line number (309 → 311) caused by the two inserted lines in README.md.

Key changes:

  • Added a > *Dependency Note:* blockquote in README.md and docs/source/get-started/installation.md accurately reflecting the nvidia-nat==1.4.0 pin present in pyproject.toml.
  • Added a bullet point to the v2.0.1 changelog entry documenting the NAT pin.
  • Updated .secrets.baseline line reference from 309 to 311 (correct offset) and refreshed the generated_at timestamp.

Confidence Score: 5/5

  • This PR is safe to merge — it contains only documentation updates with no code changes.
  • All four changed files are documentation or metadata (README.md, installation.md, changelog.md, .secrets.baseline). The dependency note is factually accurate and consistent with the actual nvidia-nat==1.4.0 pin in pyproject.toml. The .secrets.baseline line number update is arithmetically correct. No runtime, security, or behavioral risks.
  • No files require special attention.

Important Files Changed

Filename Overview
README.md Adds a blockquote dependency note warning users that this release is pinned to nvidia-nat==1.4.0; accurate and consistent with pyproject.toml.
docs/source/get-started/installation.md Adds the same NAT v1.4.0 dependency note under Prerequisites; wording matches README.md and is factually accurate.
docs/source/resources/changelog.md Adds a changelog bullet for the NAT v1.4.0 pin under the v2.0.1 (In Development) section; no issues found.
.secrets.baseline Updates README.md secret line_number from 309 to 311 (correct offset for 2 inserted lines) and refreshes the generated_at timestamp.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User installs AI-Q] --> B{Check nvidia-nat version}
    B -->|nvidia-nat==1.4.0| C[✅ Supported\nFull compatibility]
    B -->|nvidia-nat >= 1.5.0| D[⚠️ Not yet supported\nMay cause breaking changes]
    D --> E[Pin to nvidia-nat==1.4.0\nper pyproject.toml]
    E --> C
    C --> F[Run AI-Q normally]
Loading

Last reviewed commit: 81e1ce6

@AjayThorve AjayThorve merged commit fe2cf2b into NVIDIA-AI-Blueprints:develop Mar 14, 2026
4 checks passed
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