docs: refresh getting started IA#443
Closed
exactlyallan wants to merge 2 commits into
Closed
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
exactlyallan
force-pushed
the
docs/getting-started-about-skills
branch
from
July 15, 2026 22:34
28b6a1a to
6e0474d
Compare
Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
2 tasks
Collaborator
Author
|
Superseded by #479, which uses a fresh branch from latest main and a single clean docs commit. |
rapids-bot Bot
pushed a commit
that referenced
this pull request
Jul 21, 2026
#### Overview Reorganizes the getting-started docs so the runtime primer lives with the About NeMo Relay conceptual content, while Getting Started gets a short About entry point and AI-coding-assistant guidance. This replaces draft PR #443 with a clean branch and a single signed-off docs commit. - [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license. - [x] I searched existing issues and open pull requests; this supersedes #443 and does not duplicate remaining open work. #### Details - Moves Agent Runtime Primer from Getting Started to About NeMo Relay and adds a redirect from the old URL. - Adds a new Getting Started About page with starting-point guidance ordered from try-now paths to advanced development workflows. - Adds a "Using an AI coding assistant?" card to Getting Started About and Quick Start with the future no-clone `npx skills add nvidia/skills` path for installing the full Relay user-skill set. - Updates related docs and README links to the new primer location. #### Where should the reviewer start? Start with `docs/getting-started/about.mdx`, then review `docs/about-nemo-relay/agent-runtime-primer.mdx` and `docs/getting-started/quick-start/index.mdx` for the IA changes. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to NVIDIA agent skills publication follow-up. - Supersedes #443. #### Testing - `just docs` passed. Fern reported one warning: missing redirects check skipped because this local environment is not authenticated with `fern login` / `FERN_TOKEN`. ## Summary by CodeRabbit * **Documentation** * Added/expanded NeMo Relay “About” getting-started content, including guidance on selecting the smallest matching path, prerequisites, installation, configuration, and quick-start steps. * Updated Quick Start with a new “Using an AI coding assistant?” card, including skill-installation commands and catalog discovery. * Refreshed documentation navigation ordering and updated Agent Runtime Primer links across relevant pages. * Improved “starting point” routing guidance and adjusted internal doc links. * **Chores** * Added a redirect to keep existing Agent Runtime Primer links working. Authors: - Allan (https://github.com/exactlyallan) Approvers: - Will Killian (https://github.com/willkill07) URL: #479
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
Reorganizes the getting-started docs so the runtime primer lives with the About NeMo Relay conceptual content, while Getting Started gets a short About entry point and AI-coding-assistant guidance.
Details
npx skills add nvidia/skills --skill nemo-relay-get-started --agent codexpath.Where should the reviewer start?
Start with
docs/getting-started/about.mdx, then reviewdocs/about-nemo-relay/agent-runtime-primer.mdxanddocs/getting-started/quick-start/index.mdxfor the IA changes.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Testing
just docspassed. Fern reported one warning: missing redirects check skipped because this local environment is not authenticated withfern login/FERN_TOKEN.