docs: fix docs build and add migration skill#148
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
github-actions
Bot
added
size:M
WalkthroughThis PR establishes dual-runtime documentation support for NeMo Relay and NeMo Flow, adds comprehensive migration guidance and a mechanical rename automation tool, and updates metadata. The changes enable the Sphinx build to detect and adapt to either runtime variant at build time, centralizing identity and configuration through a profile model. ChangesDocumentation Runtime Profile System
NeMo Flow to Relay Migration Skills and Automation
🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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/conf.py`:
- Around line 408-416: The function _with_runtime_github_url is missing a return
type annotation; add an explicit return type (-> dict) to its signature to
satisfy static analysis and improve clarity for callers and tooling while
leaving the existing body (updated_options and icon_links handling) unchanged.
In `@skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.py`:
- Around line 169-171: The current unconditional call to
path.write_text(updated, encoding="utf-8") can raise OSError and abort the whole
migration; wrap that call in a try/except that catches OSError (and optionally
subclass like PermissionError), log a warning including path and the exception
(use the module's logger or print if none) and continue the loop so one file
write failure doesn't stop the entire run; reference the variables/path used in
this snippet (path, updated, write) and ensure the code only attempts writes
when write is true but handles failures gracefully.
- Around line 201-203: Wrap the filesystem rename call so an OSError doesn't
abort the whole migration: around the block that checks `if write:` and invokes
`change.old.rename(change.new)`, add a try/except catching OSError as e, log or
record the error (include e and the involved paths `change.old`/`change.new`),
and continue processing the remaining changes; only append `change` to `applied`
when the rename succeeds (or if `write` is False behave as before). Ensure you
reference the existing symbols `write`, `change.old.rename(change.new)`, and
`applied` when implementing the guard.
In `@skills/nemo-relay-migrate-from-flow/SKILL.md`:
- Around line 80-85: The example in SKILL.md claims the script
skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.py can be run
from the target project but uses a relative path that only works from the source
repo; update the docs so cross-repo invocation uses an absolute or
repository-root path to the migrate_from_nemo_flow.py script (or show an
alternative: change into the source repo or install/copy the script into the
target), e.g., replace the two example lines that reference skills/... with
lines that demonstrate running
/path/to/nemo-relay/skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.py
<target-path> (and the --write variant) so the procedure works exactly as
written.
🪄 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: 0b913e45-072a-4e4d-9319-4b33451c31e6
📒 Files selected for processing (5)
.git-blame-ignore-revsdocs/conf.pyskills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.mdskills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.py
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Check / Run
🧰 Additional context used
📓 Path-based instructions (24)
**/*.{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:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.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:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.md
**/*.{rs,py,js,ts,mjs,go,sh,toml,yml,yaml,md,json,css,html}
📄 CodeRabbit inference engine (AGENTS.md)
Keep SPDX headers on source, docs, scripts, and configuration files. The project is Apache-2.0.
Files:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.mdskills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.pydocs/conf.py
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license header with format:
<!-- SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. SPDX-License-Identifier: Apache-2.0 -->in HTML and Markdown files
Files:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.md
**/README.md
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Relevant package or crate README.md files must be updated when examples or binding guidance changed
Files:
skills/README.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Documentation must be updated if activation or usage changed
**/*.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 ...
Files:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.md
**/{docs,examples,**/*.md,*.patch,*.diff,.github,*.sh,*.yaml,*.yml}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, CI configuration, and patch artifacts when performing rename operations
Files:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.md
{README.md,docs/index.md,**/README.md,python/*/README.md,crates/*/README.md}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Update entry-point documentation including README.md, docs/index.md, package or crate READMEs, and binding-level source READMEs when public behavior changes
Files:
skills/README.md
{**/*.md,**/*.rst,**/*.txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
{**/*.md,**/*.rst,**/*.txt}: Commands, package names, file paths, or APIs must be correct and not stale in documentation
Do not claim support for bindings, features, or workflows in documentation that the repo no longer provides
Examples and procedures must not fail as written in documentation
User-facing naming must be consistent with current repo terminology throughout documentation
NVIDIA must be capitalized correctly in all documentation
Prefer active voice, present tense, and short sentences in documentation
Prefer 'after' over 'once' for temporal references in documentation
Use 'can' instead of 'may' when describing possibility rather than permission in documentation
Files:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.md
{**/*.md,**/*.rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
{**/*.md,**/*.rst}: Code, commands, paths, and filenames must be formatted as inline code in documentation
Headings in technical documentation must use title case consistently
Code blocks, tables, and lists must be introduced with complete lead-in sentences in documentation
Use descriptive anchor text in links rather than bare URLs or weak labels such as 'here' in documentation
Procedures must use imperative voice and parallel structure in documentation
Files:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.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:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.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:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.md
{docs/**,README.md,CONTRIBUTING.md,**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Run docs link validation with
just docs-linkcheckwhen links change
Files:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.mddocs/conf.py
{docs/**,README.md,**/Cargo.toml,**/package.json,**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Ensure renamed public surfaces are reflected consistently in manifests and docs for large or public-facing changes
Files:
skills/README.mdskills/nemo-relay-migrate-from-flow/SKILL.mddocs/conf.py
**/SKILL.md
📄 CodeRabbit inference engine (AGENTS.md)
SKILL.mdfiles are skill entrypoints and do not need SPDX headers, but they must always start with YAML frontmatter containing at leastnameanddescription.
Files:
skills/nemo-relay-migrate-from-flow/SKILL.md
⚙️ CodeRabbit configuration file
**/SKILL.md: Do not flag SKILL.md files for missing SPDX headers. Skill entrypoints intentionally start with YAML frontmatter instead.
Verify that every SKILL.md keeps valid YAML frontmatter with at least name and description fields before the Markdown body.
Files:
skills/nemo-relay-migrate-from-flow/SKILL.md
**/{*.rs,*.py,*.go,*.js,*.ts,*.mjs}
📄 CodeRabbit inference engine (AGENTS.md)
Follow binding naming conventions: Rust and Python use
snake_case, C FFI exports prefixednemo_relay_, Go usesPascalCasefor public APIs, Node.js usescamelCase.
Files:
skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.pydocs/conf.py
**/*.py
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*.py: Use Ruff with rule setsE,F,W,Ifor Python linting
Use Ruff formatter with line length 120 and double quotes for Python code formatting
Usetyfor Python type checking
Use Pythonsnake_casenaming convention for Python code
Runjust test-pythonfor Python test suite
**/*.py: Run Python formatting withuv run ruff format python
Run Python testing withuv run pytest -k "<pattern>"
Files:
skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.pydocs/conf.py
**/*.{py,toml}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license header with format:
# SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0in Python and TOML files
Files:
skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.pydocs/conf.py
{pyproject.toml,**/*.py}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Maintain consistency between Python package names in
pyproject.tomland import paths used throughout the codebase
Files:
skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.pydocs/conf.py
**/*.{py,txt,toml,cfg,yaml,yml}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update Python package names and top-level module imports during coordinated rename operations
Files:
skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.pydocs/conf.py
{docs/**,README.md,CONTRIBUTING.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
{docs/**,README.md,CONTRIBUTING.md}: For docs-only changes, run targeted checks only if commands, package names, or examples changed. Usejust docsfor docs-site builds andjust docs-linkcheckwhen links changed
Run docs site build withjust docs
Files:
docs/conf.py
{docs/**,README.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Verify README and docs entry points still match current package names and paths for large or public-facing changes
Files:
docs/conf.py
{docs/**,examples/**,README.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Verify examples still run with documented commands for large or public-facing changes
Files:
docs/conf.py
{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/conf.py
🧠 Learnings (1)
📚 Learning: 2026-04-15T18:16:52.951Z
Learnt from: bbednarski9
Repo: NVIDIA/NeMo-Flow PR: 1
File: docs/atof-event-format.md:381-381
Timestamp: 2026-04-15T18:16:52.951Z
Learning: In docs/atof-event-format.md (and when reviewing references to this format across the NeMo-Flow repo), treat `AtifExporter.events_to_steps()` as the intended public/API method name. Do not flag it as inconsistent with internal Rust symbol names (e.g., `event_to_steps` in `crates/core/src/atif.rs`)—the documentation’s public-facing naming may differ intentionally from internal implementation details.
Applied to files:
.git-blame-ignore-revs
🪛 LanguageTool
skills/nemo-relay-migrate-from-flow/SKILL.md
[style] ~101-~101: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... test ./...` from the updated module. - For docs-only migrations, build or link-che...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 Ruff (0.15.13)
skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.py
[warning] 128-128: Boolean-typed positional argument in function definition
(FBT001)
[warning] 134-134: Boolean-typed positional argument in function definition
(FBT001)
[warning] 140-140: Boolean-typed positional argument in function definition
(FBT001)
[warning] 140-140: Boolean-typed positional argument in function definition
(FBT001)
[warning] 150-150: Boolean-typed positional argument in function definition
(FBT001)
[warning] 180-180: Boolean-typed positional argument in function definition
(FBT001)
[warning] 195-195: Boolean-typed positional argument in function definition
(FBT001)
[warning] 210-210: Boolean-typed positional argument in function definition
(FBT001)
docs/conf.py
[warning] 401-405: Avoid specifying long messages outside the exception class
(TRY003)
[warning] 408-408: Missing return type annotation for private function _with_runtime_github_url
(ANN202)
🔇 Additional comments (8)
skills/README.md (1)
22-22: LGTM!docs/conf.py (6)
19-42: LGTM!
44-44: LGTM!
142-142: LGTM!Also applies to: 159-159
393-405: LGTM!
419-428: LGTM!
525-525: LGTM!.git-blame-ignore-revs (1)
1-5: LGTM!
|
/merge |
2 participants
Overview
Fix the documentation build configuration and add a migration skill for updating NeMo Flow references and APIs to NeMo Relay.
Details
docs/conf.pyso generated API docs build cleanly with the renamed package surfaces.skills/README.md.skills/nemo-relay-migrate-from-flow/with workflow guidance and a helper script for migrating NeMo Flow names, imports, package references, and docs text to NeMo Relay.just docspassed.Where should the reviewer start?
Start with
docs/conf.pyfor the docs-build behavior, then reviewskills/nemo-relay-migrate-from-flow/SKILL.mdandskills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.pyfor the migration workflow and helper implementation.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit
Release Notes
New Features
Documentation