docs: refresh getting started IA#479
Conversation
github-actions
Bot
added
size:M
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (3)
📜 Recent review details⏰ Context from checks skipped due to timeout. (2)
🧰 Additional context used📓 Path-based instructions (16)**/*.{md,rst,html,txt}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Files:
**/*.{md,rst,html}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Files:
**/*.{md,rst,txt}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Files:
**/*.{md,rst}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Files:
**/*.md📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
Files:
{README.md,docs/**/*.{md,rst,txt},fern/**/*}📄 CodeRabbit inference engine (.agents/skills/prepare-code-freeze/SKILL.md)
Files:
**/*.{md,mdx}📄 CodeRabbit inference engine (AGENTS.md)
Files:
**/*.{md,markdown,mdx}📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
{docs/**/*.md,README.md}📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Files:
{README.md,docs/index.md}📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Files:
**/*📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
README.md📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}⚙️ CodeRabbit configuration file
Files:
**/*.mdx📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Files:
{docs,examples}/**/*📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Files:
docs/**/*📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
🔇 Additional comments (4)
WalkthroughThe documentation adds a dedicated Getting Started page, moves Agent Runtime Primer content under About NeMo Relay, updates navigation and cross-links, adds AI coding assistant guidance, and redirects the previous primer route. ChangesGetting Started documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
willkill07
left a comment
willkill07
left a comment
There was a problem hiding this comment.
All commits must be based on release/0.6, not main.
As is, we are including all updates from main in this PR.
Also, pre-commit is failing because have linkcheck failures:
https://github.com/NVIDIA/NeMo-Relay/actions/runs/29718079928/job/88275176343
Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
1e71f57 to
acd1eae
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/getting-started/about.mdx`:
- Line 17: Update the card title at docs/getting-started/about.mdx lines 17-17
and the matching title at docs/getting-started/quick-start/index.mdx lines 23-23
to use the exact title-cased wording “Using an AI Coding Assistant?”.
🪄 Autofix (Beta)
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: ASSERTIVE
Plan: Enterprise
Run ID: cde0a59e-5e4c-4d7a-816b-9cf96b3a0fa6
📒 Files selected for processing (13)
README.mddocs/about-nemo-relay/agent-runtime-primer.mdxdocs/about-nemo-relay/architecture.mdxdocs/about-nemo-relay/concepts/index.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/contribute/runtime-contract-docs.mdxdocs/getting-started/about.mdxdocs/getting-started/quick-start/index.mdxdocs/reference/api/index.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxfern/docs.yml
📜 Review details
🧰 Additional context used
📓 Path-based instructions (18)
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)
In MDX files, top-of-file comments must use JSX comment delimiters (
{/*to open and*/}to close); do not use HTML comments for MDX SPDX headers
Files:
docs/about-nemo-relay/concepts/index.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/reference/api/index.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/contribute/runtime-contract-docs.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/architecture.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/agent-runtime-primer.mdxdocs/getting-started/about.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
docs/about-nemo-relay/concepts/index.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/reference/api/index.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/contribute/runtime-contract-docs.mdxREADME.mddocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/architecture.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/agent-runtime-primer.mdxdocs/getting-started/about.mdx
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
docs/about-nemo-relay/concepts/index.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/reference/api/index.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/contribute/runtime-contract-docs.mdxREADME.mddocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/architecture.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/agent-runtime-primer.mdxdocs/getting-started/about.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/about-nemo-relay/concepts/index.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/reference/api/index.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/contribute/runtime-contract-docs.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/architecture.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/agent-runtime-primer.mdxdocs/getting-started/about.mdx
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
docs/about-nemo-relay/concepts/index.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/reference/api/index.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/contribute/runtime-contract-docs.mdxREADME.mddocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/architecture.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/getting-started/quick-start/index.mdxfern/docs.ymldocs/about-nemo-relay/agent-runtime-primer.mdxdocs/getting-started/about.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands under
docs/change, run the targeted docs checks appropriate to the change.
Files:
docs/about-nemo-relay/concepts/index.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/reference/api/index.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/contribute/runtime-contract-docs.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/architecture.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/agent-runtime-primer.mdxdocs/getting-started/about.mdx
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.
Files:
docs/about-nemo-relay/concepts/index.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/reference/api/index.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/contribute/runtime-contract-docs.mdxREADME.mddocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/architecture.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/agent-runtime-primer.mdxdocs/getting-started/about.mdx
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx: Update onlydocs/about-nemo-relay/release-notes/index.mdx,docs/about-nemo-relay/release-notes/highlights.mdx, anddocs/about-nemo-relay/release-notes/known-issues.mdxunless the release changes their route or entry points.
Preserve the existing MDX front matter and the JSX SPDX comment in the release-notes pages.
Files:
docs/about-nemo-relay/release-notes/index.mdx
{CONTRIBUTING.md,docs/contribute/**/*.{md,mdx}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
When documenting contribution workflow, require an issue before external contribution PRs and note that NVIDIA contributors may use a GitHub or Linear issue
Files:
docs/contribute/runtime-contract-docs.mdx
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
README.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
README.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
README.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as "here" or "read more."
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
README.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
README.md
{README.md,docs/**/*.{md,rst,txt},fern/**/*}
📄 CodeRabbit inference engine (.agents/skills/prepare-code-freeze/SKILL.md)
Search and update documentation source for references to the old version in
README.md,docs, andferndirectories, updating current-version install commands, package examples, and configuration examples to<next-version>
Files:
README.mdfern/docs.yml
{docs/**/*.md,README.md}
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update reference docs, language-binding docs, READMEs, and example documentation when the public surface or expected usage changes.
Files:
README.md
{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update entry-point docs when examples or reading paths change
Files:
README.md
README.md
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands in
README.mdchange, run the targeted docs checks appropriate to the change.
Files:
README.md
🔇 Additional comments (11)
docs/getting-started/about.mdx (2)
22-100: 📐 Maintainability & Code QualityRun the Required Documentation Link Check.
Run
just docs-linkcheckand attach the successful result before merge.
docs/getting-started/about.mdx#L22-L100: Validate added external and internal links.docs/about-nemo-relay/agent-runtime-primer.mdx#L95-L95: Validate the new Getting Started route.docs/getting-started/quick-start/index.mdx#L18-L50: Validate relocated and external links.docs/reference/api/index.mdx#L21-L23: Validate the relocated primer route.docs/resources/troubleshooting/trace-incident-runbook.mdx#L17-L17: Validate the relocated primer route.As per coding guidelines, if links in documentation change, run
just docs-linkcheck.Source: Coding guidelines
22-47: 🎯 Functional CorrectnessNo change needed. These commands are already gated on publication in
nvidia/skills, and the listed skill names exist in this repo’s skill set.> Likely an incorrect or invalid review comment.docs/about-nemo-relay/agent-runtime-primer.mdx (1)
4-4: LGTM!Also applies to: 14-15
docs/about-nemo-relay/architecture.mdx (1)
4-4: LGTM!docs/about-nemo-relay/concepts/index.mdx (1)
4-4: LGTM!docs/about-nemo-relay/ecosystem.mdx (1)
4-4: LGTM!docs/about-nemo-relay/release-notes/index.mdx (1)
4-4: LGTM!docs/contribute/runtime-contract-docs.mdx (1)
30-31: LGTM!fern/docs.yml (1)
83-85: LGTM!README.md (1)
338-340: LGTM!docs/about-nemo-relay/overview.mdx (1)
118-118: LGTM!
Keep README links on currently published docs routes, omit the future Agent Runtime Primer production link until publish, and apply the requested title-case wording for the AI coding assistant cards. Validation: UV_CACHE_DIR=/private/tmp/uv-cache XDG_CACHE_HOME=/private/tmp uv run pre-commit run lychee --all-files; UV_CACHE_DIR=/private/tmp/uv-cache XDG_CACHE_HOME=/private/tmp just docs-linkcheck Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
|
Ready for review again. Follow-up cleanup pushed in
Validation:
Both passed locally. |
|
/merge |
2 participants
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.
Details
npx skills add nvidia/skillspath for installing the full Relay user-skill set.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.Summary by CodeRabbit