docs(nemo-agents): refresh docs for Fabric Integration - #1051
Merged
mmogallapalli merged 14 commits intoAug 4, 2026
Merged
Conversation
Contributor
|
mmogallapalli
force-pushed
the
mmogallapall/aircore-957-write-user-facing-docs-for-the-fabric-backed-agent-flow-and
branch
from
August 3, 2026 21:42
43dcd0a to
939e83c
Compare
mmogallapalli
changed the title
mmogallapalli
changed the title
Signed-off-by: Manjesh Mogallapalli <mmogallapall@nvidia.com>
Signed-off-by: Manjesh Mogallapalli <mmogallapall@nvidia.com>
mmogallapalli
force-pushed
the
mmogallapall/aircore-957-write-user-facing-docs-for-the-fabric-backed-agent-flow-and
branch
from
August 4, 2026 15:33
939e83c to
40546fb
Compare
Signed-off-by: Manjesh Mogallapalli <mmogallapall@nvidia.com>
Contributor
Signed-off-by: Manjesh Mogallapalli <mmogallapall@nvidia.com>
Signed-off-by: Manjesh Mogallapalli <mmogallapall@nvidia.com>
Signed-off-by: Manjesh Mogallapalli <mmogallapall@nvidia.com>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughThe documentation now presents packaged Platform-managed ChangesPlatform-managed agent documentation
Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/agents/index.mdx`:
- Around line 7-101: Restructure the three documentation pages to use one
Diataxis type, place prerequisites immediately after each title, and end each
page with a Next Steps section. In docs/agents/index.mdx:7-101, retain the agent
overview and link to separate contract-reference and lifecycle-how-to pages. In
plugins/nemo-agents/README.md:3-82, move prerequisites before the workflow
comparison and link to separate walkthrough and packaging-reference pages. In
plugins/nemo-agents/examples/nemo-agent-config/README.md:3-39, add prerequisites
before the invoke instructions and add Next Steps after the Relay sections.
In `@plugins/nemo-agents/examples/nemo-agent-config/calculator-agent/agent.yaml`:
- Around line 47-50: Update the ATIF storage endpoint in the calculator agent
configuration to use a container-reachable Intake URL instead of 127.0.0.1:8080,
or provide a deployment-specific override that rewrites
telemetry.atif.storage[*].endpoint for Docker and Kubernetes deployments.
In `@plugins/nemo-agents/README.md`:
- Line 563: Rename the NAT walkthrough headings at the referenced sections to
unique, task-specific headings, preferably by prefixing each with “NAT.” Update
the headings corresponding to “Step 1 — Start the platform” and the other
duplicated headings while preserving their existing step structure and content.
- Around line 90-124: The documentation workflows across three files call
Platform-dependent CLI commands without verifying readiness. In
plugins/nemo-agents/README.md at lines 90-124, add a preflight section before
the provider setup that sets NMP_BASE_URL to http://localhost:8080, checks for
an existing running instance, and verifies the /health/ready endpoint. Apply the
same preflight pattern in
plugins/nemo-agents/examples/nemo-agent-config/README.md at lines 41-63 before
nemo setup and agent commands, and in docs/agents/deploy-agents.mdx at lines
51-66 before the subprocess example, ensuring all local Platform CLI operations
follow the same readiness validation approach.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 6f14d866-e6d6-4a86-bdfa-c7c5d246597f
📒 Files selected for processing (7)
docs/agents/deploy-agents.mdxdocs/agents/index.mdxdocs/agents/plugins.mdxdocs/index.mdxplugins/nemo-agents/README.mdplugins/nemo-agents/examples/nemo-agent-config/README.mdplugins/nemo-agents/examples/nemo-agent-config/calculator-agent/agent.yaml
Signed-off-by: Manjesh Mogallapalli <mmogallapall@nvidia.com>
Signed-off-by: Manjesh Mogallapalli <mmogallapall@nvidia.com>
Signed-off-by: Manjesh Mogallapalli <mmogallapall@nvidia.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@plugins/nemo-agents/examples/nemo-agent-config/README.md`:
- Around line 8-15: Update the setup instructions in the README to narrow the
dependency claim so it does not imply the Relay CLI is installed with the
plugin. Add the separate Relay prerequisite by instructing users to run the
existing development installation script and verify it with nemo-relay --version
before the harness authentication steps.
In `@plugins/nemo-agents/src/nemo_agents_plugin/runner/deployments_backend.py`:
- Around line 221-230: Update the endpoint rewrite in the storage-config loop to
preserve an HTTPS source scheme instead of replacing it with HTTP;
credential-bearing endpoints must not be downgraded, and should use HTTPS for
the reachable gateway. Add regression coverage for an HTTPS loopback ATIF
storage endpoint, including the header_env credential case.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 465509ff-46c6-43f8-b4ba-9b331e1d2144
⛔ Files ignored due to path filters (6)
sdk/python/nemo-platform/src/nemo_platform/skills/nemo-agent-config/SKILL.mdis excluded by!sdk/**sdk/python/nemo-platform/src/nemo_platform/skills/nemo-build-agent/SKILL.mdis excluded by!sdk/**sdk/python/nemo-platform/src/nemo_platform/skills/nemo-model-selection/SKILL.mdis excluded by!sdk/**sdk/python/nemo-platform/src/nemo_platform/skills/nemo-skill-selection/SKILL.mdis excluded by!sdk/**sdk/python/nemo-platform/src/nemo_platform/skills/nemo-spec/SKILL.mdis excluded by!sdk/**sdk/python/nemo-platform/src/nemo_platform/skills/nemo-try-agent/SKILL.mdis excluded by!sdk/**
📒 Files selected for processing (17)
docs/agents/deploy-agents.mdxdocs/agents/index.mdxdocs/agents/plugins.mdxdocs/index.mdxe2e/test_nemo_agents.pypackages/nemo_platform_ext/src/nemo_platform_ext/skills/nemo-agent-config/SKILL.mdpackages/nemo_platform_ext/src/nemo_platform_ext/skills/nemo-build-agent/SKILL.mdpackages/nemo_platform_ext/src/nemo_platform_ext/skills/nemo-model-selection/SKILL.mdpackages/nemo_platform_ext/src/nemo_platform_ext/skills/nemo-skill-selection/SKILL.mdpackages/nemo_platform_ext/src/nemo_platform_ext/skills/nemo-spec/SKILL.mdpackages/nemo_platform_ext/src/nemo_platform_ext/skills/nemo-try-agent/SKILL.mdplugins/nemo-agents/README.mdplugins/nemo-agents/examples/nemo-agent-config/README.mdplugins/nemo-agents/examples/nemo-agent-config/calculator-agent/agent.yamlplugins/nemo-agents/src/nemo_agents_plugin/fabric/README.mdplugins/nemo-agents/src/nemo_agents_plugin/runner/deployments_backend.pyplugins/nemo-agents/tests/unit/test_runner_deployments.py
🚧 Files skipped from review as they are similar to previous changes (5)
- docs/index.mdx
- docs/agents/plugins.mdx
- plugins/nemo-agents/examples/nemo-agent-config/calculator-agent/agent.yaml
- docs/agents/deploy-agents.mdx
- plugins/nemo-agents/README.md
yamini
approved these changes
Aug 4, 2026
mmogallapalli
deleted the
mmogallapall/aircore-957-write-user-facing-docs-for-the-fabric-backed-agent-flow-and
branch
August 4, 2026 22:00
This was referenced Aug 4, 2026
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
2 participants
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.
Summary by CodeRabbit
New Features
Bug Fixes
Documentation