Skip to content

docs: refresh getting started IA#443

Closed
exactlyallan wants to merge 2 commits into
NVIDIA:mainfrom
exactlyallan:docs/getting-started-about-skills
Closed

docs: refresh getting started IA#443
exactlyallan wants to merge 2 commits into
NVIDIA:mainfrom
exactlyallan:docs/getting-started-about-skills

Conversation

@exactlyallan

Copy link
Copy Markdown
Collaborator

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.

  • I 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.

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 and a compact setup flow.
  • 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 --skill nemo-relay-get-started --agent codex path.
  • 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.

Testing

  • just docs passed. Fern reported one warning: missing redirects check skipped because this local environment is not authenticated with fern login / FERN_TOKEN.

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: d2c7f92e-7797-4941-b4ee-df56925df3bf

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@github-actions github-actions Bot added size:M PR is medium Documentation documentation-related labels Jul 15, 2026
Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
@exactlyallan
exactlyallan force-pushed the docs/getting-started-about-skills branch from 28b6a1a to 6e0474d Compare July 15, 2026 22:34
@exactlyallan
exactlyallan changed the base branch from relay-skill-ci-3 to main July 15, 2026 22:34
@exactlyallan exactlyallan self-assigned this Jul 15, 2026
Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
@github-actions

Copy link
Copy Markdown

@willkill07 willkill07 added this to the 0.6 milestone Jul 16, 2026
@exactlyallan

Copy link
Copy Markdown
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation documentation-related size:M PR is medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants