docs: clarify README onboarding and integrations - #1
Merged
dagardner-nv merged 4 commits intoJul 23, 2026
Conversation
Signed-off-by: Anuradha Karuppiah <26330987+AnuradhaKaruppiah@users.noreply.github.com>
Signed-off-by: Anuradha Karuppiah <26330987+AnuradhaKaruppiah@users.noreply.github.com>
AnuradhaKaruppiah
marked this pull request as ready for review
July 23, 2026 00:57
Signed-off-by: Anuradha Karuppiah <26330987+AnuradhaKaruppiah@users.noreply.github.com>
dagardner-nv
approved these changes
Jul 23, 2026
This branch was successfully deployed
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.
Overview
Polish the README refactor in NVIDIA#103 so new users see the
product purpose, supported harnesses, simplest working setup, common deployment
topologies, and integration paths in a clearer sequence.
This is a documentation-only change. It does not change runtime behavior or
public APIs.
Details
Rollouts version and update its alternative text.
start, separate execution environments, execution flow, goal-based next
steps, and roadmap items for custom harnesses and custom agents.
southbound across the README, documentation navigation, and consumer-skill
index.
docs/integrations/consumer/anddocs/integrations/harness/, with a focused overview for each direction.skill under
skills/integrations/consumer/and reservingskills/integrations/harness/for the forthcoming adapter-authoring skill.Validation
git diff --checkNODE_OPTIONS=--experimental-global-webcrypto npx --prefix docs --no-install fern check --warningsFERN_TOKENwas available.NODE_OPTIONS=--experimental-global-webcrypto npx --prefix docs --no-install fern docs broken-links --strictquick_validate.py)skills/integrations/consumer/nemo-fabric-integrate.No runtime test suites were run because the change is documentation-only.
Where should the reviewer start?
Start with
README.mdfor the revised onboarding flow and terminology, thenreview
docs/index.yml,docs/integrations/consumer/overview.mdx, anddocs/integrations/harness/overview.mdxfor the matching integrationorganization. Then review
skills/README.mdfor the corresponding portableskill layout.
Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Relates to docs: Reafactor the
README.mdNVIDIA/NeMo-Fabric#103I confirm this contribution is my own work, or I have the right to submit it under this project's license.
I searched existing issues and open pull requests, and this does not duplicate existing work.