docs: reorganize navigation and integration guidance#118
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
github-actions
Bot
added
size:M
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
WalkthroughAdds first-class NeMo Flow CLI docs and per-agent guides; introduces plugins/observability and plugins/adaptive doc trees (configuration, exporter pages, examples, manual APIs); migrates and simplifies many guide titles/links; expands ATIF/ATOF/ACG acronyms in docstrings; updates READMEs and one adaptive crate Result alias. ChangesUnified documentation & small code alignment
🎯 3 (Moderate) | ⏱️ ~20 minutes
✨ Finishing Touches🧪 Generate unit tests (beta)
|
![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 `@README.md`:
- Around line 144-145: Replace the vague sentence "Refer to the NeMo Flow CLI
documentation for additional information" with a direct, descriptive link to the
CLI About page; locate the sentence in README.md (the paragraph that starts
"NeMo Flow CLI offers experimental support for several agent harnesses.") and
update it to use descriptive anchor text like "NeMo Flow CLI — About" that
points to the specific CLI About documentation URL so readers land directly on
the detailed guide.
🪄 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: c2e8f114-06ca-4e72-bbfc-6e67ea35d406
📒 Files selected for processing (18)
README.mdcrates/cli/README.mdcrates/wasm/README.mddocs/getting-started/installation.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/about.mddocs/integrate-frameworks/openclaw-plugin.mddocs/nemo-flow-cli/about.mddocs/nemo-flow-cli/basic-usage.mddocs/nemo-flow-cli/claude-code.mddocs/nemo-flow-cli/codex.mddocs/nemo-flow-cli/cursor.mddocs/nemo-flow-cli/hermes.mddocs/reference/api/rust/index.mddocs/resources/support-and-faqs.mdintegrations/openclaw/README.mdpython/nemo_flow/README.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (28)
**/*.{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:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.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:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst,txt}: SpellNVIDIAin all caps. Do not useNvidia,nvidia, orNV.
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 documentation.
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 documentation unless the source, platform, or legal guidance explicitly requires them.
Do not add trademark symbols to NeMo Flow learning documentation by default.
Do not rewrite API names, package names, command flags, or code literals for style reasons.
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
**/*.{md,markdown,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.{md,markdown,rst}: 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
Use monospace formatting for code elements, commands, parameters, package names, and expressions
Use monospace formatting for directories, file names, and paths
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Use quotation marks for error messages and strings in documentation
Use bold formatting for UI buttons, menus, fields, and labels in documentation
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use in documentation
Use italics for publication titles in documentation
Use plain text formatting for keyboard shortcuts in documentation
Prefer[NVIDIA/NeMo](link)format for GitHub repository references over generic phrases 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 in documentation
Avoid generic link anchors such as 'here,' 'this page,' and 'read more' in documentation
Include the acronym in link text if a linked term includes an acronym
Do not link long sentences or multiple sentences in documentation
Avoid links that pull readers away from a procedure unles...
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license headers in HTML and Markdown files using HTML comment syntax
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
docs/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run
./scripts/build-docs.shfor documentation site changes
docs/**/*.md: Relevant getting-started or reference docs must be updated when examples change
Release-policy docs must point to GitHub Releases as the only release-history source of truth
docs/**/*.md: Use title case for headings in technical documentation
Introduce code blocks, tables, and lists with complete lead-in sentences in documentation
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mddocs/reference/api/rust/index.mddocs/nemo-flow-cli/basic-usage.mddocs/nemo-flow-cli/about.mddocs/index.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run Markdown link checking via
lycheeforREADME.md,CONTRIBUTING.md, anddocs/through pre-commit hooks
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
**/*.{md,markdown,py,sh,bash,js,ts,java,cpp,go,rust}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repo references, and build commands current in documentation
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
{RELEASING.md,CHANGELOG.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep release-process and release-notes guidance in repo-maintainer docs such as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mddocs/reference/api/rust/index.mddocs/nemo-flow-cli/basic-usage.mddocs/nemo-flow-cli/about.mddocs/index.md
**/*.{md,markdown,py,sh,bash}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep stable user-facing wrappers at scripts/ root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
**/*.{md,markdown,py,sh,bash,js,ts,example}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Example commands must match current package names and paths
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
{scripts/*.sh,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Use root
./scripts/*.shcommands in docs and contributor guidance as documented, with implementations underscripts/third-party/
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mddocs/reference/api/rust/index.mddocs/nemo-flow-cli/basic-usage.mddocs/nemo-flow-cli/about.mddocs/index.md
{docs/**,examples/**,crates/adaptive/**,python/nemo_flow/**,go/nemo_flow/**,**/{example,component}.{ts,tsx,js,rs,py,go}}
📄 CodeRabbit inference engine (.agents/skills/maintain-optimizer/SKILL.md)
Any new adaptive component kind must have documentation, examples, and binding coverage across all supported languages
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mddocs/reference/api/rust/index.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.md
{README*,CHANGELOG*,docs/**/*.{md,rst,txt},examples/**/*,*.md}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, and getting-started guides with new package/module/crate names after rename operations
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mddocs/reference/api/rust/index.mddocs/nemo-flow-cli/basic-usage.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
**/*.{md,txt,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,txt,rst}: Ensure commands, package names, file paths, and APIs in documentation are correct and not stale; flag incorrect or outdated information as blocking issues
Ensure examples and procedures in documentation will execute successfully with current APIs and commands
Use consistent user-facing terminology throughout documentation that matches current repo terminology
Capitalize NVIDIA correctly in all documentation and public-facing text
Format code, commands, paths, and filenames as inline code (monospace) in documentation
Use descriptive anchor text for links instead of bare URLs or weak labels like 'here' in documentation
Prefer active voice, present tense, short sentences, and plain English in documentation
Structure documentation procedures as imperative steps that are easy to scan and not too long for a single sequence
Prefer 'after' instead of 'once' for temporal references in documentation
Use 'can' instead of 'may' when describing possibility (rather than permission) in documentation
Avoid ambiguous numeric dates and ordinal dates in documentation body text
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
{README.md,docs/**/*.md,examples/**/*.{js,ts,py,go,rs}}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Keep documentation and examples synchronized with current install, import, and build commands
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mddocs/reference/api/rust/index.mddocs/nemo-flow-cli/basic-usage.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
**/*.{py,js,ts,tsx,go,rs,md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Format changed files with the language-native formatter before the final lint/test pass
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mdcrates/cli/README.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mdcrates/wasm/README.mddocs/reference/api/rust/index.mdintegrations/openclaw/README.mddocs/nemo-flow-cli/basic-usage.mdpython/nemo_flow/README.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
{README.md,CONTRIBUTING.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For docs-only changes, run targeted checks only if commands, package names, or examples changed. Use
just docsfor docs-site builds andjust docs-linkcheckwhen links changed
Files:
docs/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mddocs/reference/api/rust/index.mddocs/nemo-flow-cli/basic-usage.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
{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/resources/support-and-faqs.mddocs/nemo-flow-cli/cursor.mddocs/nemo-flow-cli/claude-code.mddocs/getting-started/installation.mddocs/integrate-frameworks/about.mddocs/getting-started/rust.mddocs/nemo-flow-cli/hermes.mddocs/nemo-flow-cli/codex.mddocs/integrate-frameworks/openclaw-plugin.mddocs/reference/api/rust/index.mddocs/nemo-flow-cli/basic-usage.mddocs/nemo-flow-cli/about.mddocs/index.mdREADME.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant crate or package README when that surface changed
Relevant package or crate README.md files must be updated when examples or binding guidance changes
Files:
crates/cli/README.mdcrates/wasm/README.mdintegrations/openclaw/README.mdpython/nemo_flow/README.mdREADME.md
{README.md,docs/index.md,**/README.md}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Update entry-point documentation (README.md, docs/index.md, package READMEs, binding-level source READMEs) whenever public behavior changes
Files:
crates/cli/README.mdcrates/wasm/README.mdintegrations/openclaw/README.mdpython/nemo_flow/README.mddocs/index.mdREADME.md
docs/integrate-frameworks/**/*.md
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Documentation must be updated if activation or usage of the integration changed
Files:
docs/integrate-frameworks/about.mddocs/integrate-frameworks/openclaw-plugin.md
crates/{python,ffi,node,wasm}/**/*
⚙️ CodeRabbit configuration file
crates/{python,ffi,node,wasm}/**/*: Treat binding changes as public API changes. Check for parity with the other language bindings, FFI ownership/lifetime safety,
callback error propagation, stable type conversion, and consistent async/stream semantics.
Flag changes that update one binding without corresponding tests or documentation for the same surface elsewhere.
Files:
crates/wasm/README.md
docs/reference/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant reference documentation for any public API changes
Files:
docs/reference/api/rust/index.md
**/{integrations,integration,*-integration}/**
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
**/{integrations,integration,*-integration}/**: Keep NeMo Flow optional in framework integrations
Preserve the framework's original behavior when NeMo Flow is absent
Wrap tool and LLM paths at the correct framework boundary
Integration pattern must followdocs/integrate-frameworks/adding-scopes.md
Files:
integrations/openclaw/README.md
python/nemo_flow/**/*
⚙️ CodeRabbit configuration file
python/nemo_flow/**/*: Review Python wrapper changes for typed API consistency, contextvars-based scope isolation, async behavior, and parity with the native extension.
Stubs and runtime implementations should stay aligned.
Files:
python/nemo_flow/README.md
{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
{README.md,docs/index.md}: Update entry-point docs when examples or reading paths change
README.md or docs/index.md must be updated when entry points change
Files:
docs/index.mdREADME.md
README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update README.md to reflect current workspace members and top-level documentation for changes affecting public behavior, bindings, examples, or workspace structure
Files:
README.md
🔇 Additional comments (27)
README.md (4)
111-115: LGTM!
137-137: LGTM!
161-208: LGTM!
210-221: LGTM!crates/cli/README.md (2)
20-32: LGTM!
136-136: LGTM!crates/wasm/README.md (1)
28-30: LGTM!python/nemo_flow/README.md (3)
91-103: LGTM!Also applies to: 121-123
166-166: LGTM!
93-93: ⚡ Quick winURL is valid and active.
The Deep Agents documentation link returns HTTP 200, confirming it is accessible and not broken. The markdown link format with descriptive text complies with documentation guidelines.
docs/index.md (3)
59-59: LGTM!
165-165: LGTM!
173-184: LGTM!docs/nemo-flow-cli/about.md (1)
1-62: LGTM!docs/nemo-flow-cli/basic-usage.md (2)
6-6: LGTM!
260-263: LGTM!docs/nemo-flow-cli/claude-code.md (1)
6-6: LGTM!docs/nemo-flow-cli/codex.md (1)
6-6: LGTM!docs/nemo-flow-cli/cursor.md (1)
6-6: LGTM!docs/nemo-flow-cli/hermes.md (1)
6-6: LGTM!docs/getting-started/installation.md (1)
50-52: LGTM!Also applies to: 106-107
docs/getting-started/rust.md (1)
29-29: LGTM!Also applies to: 42-43
docs/integrate-frameworks/about.md (1)
49-52: LGTM!docs/integrate-frameworks/openclaw-plugin.md (1)
14-18: LGTM!Also applies to: 228-230
docs/reference/api/rust/index.md (1)
43-43: LGTM!Also applies to: 82-82
docs/resources/support-and-faqs.md (1)
163-163: LGTM!integrations/openclaw/README.md (1)
14-17: LGTM!Also applies to: 186-187
Signed-off-by: Will Killian <wkillian@nvidia.com>
Signed-off-by: Will Killian <wkillian@nvidia.com>
Signed-off-by: Will Killian <wkillian@nvidia.com>
github-actions
Bot
added
size:XXL
willkill07
changed the title
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 `@crates/cli/README.md`:
- Line 135: Replace the raw URL text "https://nvidia.github.io/NeMo-Flow/" with
descriptive Markdown link text by changing the inline occurrence to use
bracketed text and the URL in parentheses (e.g., replace the raw URL string with
[NeMo Flow Documentation](https://nvidia.github.io/NeMo-Flow/)); locate the raw
URL occurrence in the README.md body and update it accordingly so the rendered
text shows the descriptive anchor instead of the bare URL.
In `@crates/wasm/README.md`:
- Line 18: The README header was generalized to "# NeMo Flow" reducing package
specificity; change the top-level header in this README back to a
package-specific title such as "# nemo-flow-wasm" or a clearer alternative like
"# NeMo Flow WebAssembly Bindings" so readers immediately know this document
describes the wasm bindings for the package.
In `@docs/resources/support-and-faqs.md`:
- Line 324: The link list under the "How Are Events Observed?" section contains
a duplicated "Subscribers" entry; remove the second "Subscribers" link (the
duplicate of the earlier entry) or replace it with the intended distinct
destination (e.g., an "Observability" or "Event Observability" link) so the list
entries are unique and meaningful—update the second list item that currently
reads "Subscribers" to the correct link text and target or delete that list item
entirely.
🪄 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: eeb1bb7d-6333-457f-8337-1307ba812d0b
📒 Files selected for processing (116)
crates/adaptive/README.mdcrates/adaptive/src/acg/anthropic_plugin.rscrates/adaptive/src/acg/error.rscrates/adaptive/src/acg/ir_builder.rscrates/adaptive/src/acg/mod.rscrates/adaptive/src/acg/openai_plugin.rscrates/adaptive/src/acg/plugin.rscrates/adaptive/src/acg/policy.rscrates/adaptive/src/acg/profile.rscrates/adaptive/src/acg/prompt_ir.rscrates/adaptive/src/acg/telemetry.rscrates/adaptive/src/acg/types.rscrates/adaptive/src/acg_component.rscrates/adaptive/src/acg_learner.rscrates/adaptive/src/acg_profile.rscrates/adaptive/src/config.rscrates/adaptive/src/intercepts.rscrates/adaptive/src/lib.rscrates/adaptive/src/plugin_component.rscrates/adaptive/src/storage/traits.rscrates/adaptive/src/types/cache.rscrates/adaptive/src/types/records.rscrates/cli/README.mdcrates/cli/src/launcher.rscrates/core/README.mdcrates/core/src/api/event.rscrates/core/src/api/llm.rscrates/core/src/api/scope.rscrates/core/src/api/tool.rscrates/core/src/observability/atif.rscrates/core/src/observability/atof.rscrates/core/src/observability/plugin_component.rscrates/core/src/stream.rscrates/ffi/README.mdcrates/ffi/nemo_flow.hcrates/ffi/src/types/mod.rscrates/node/README.mdcrates/node/adaptive.d.tscrates/node/observability.d.tscrates/node/src/api/mod.rscrates/python/README.mdcrates/wasm/README.mddocs/about/concepts/plugins.mddocs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/highlights.mddocs/build-plugins/about.mddocs/build-plugins/advanced-configuration.mddocs/build-plugins/basic-guide.mddocs/build-plugins/plugin-configuration-files.mddocs/build-plugins/register-behavior.mddocs/build-plugins/validate-configuration.mddocs/contribute/development-setup.mddocs/export-observability-data/about.mddocs/export-observability-data/advanced-guide.mddocs/export-observability-data/atif.mddocs/export-observability-data/basic-guide.mddocs/export-observability-data/code-examples.mddocs/export-observability-data/observability-plugin.mddocs/export-observability-data/opentelemetry.mddocs/getting-started/configuration.mddocs/getting-started/installation.mddocs/getting-started/nodejs.mddocs/getting-started/prerequisites.mddocs/getting-started/python/index.mddocs/getting-started/rust.mddocs/index.mddocs/instrument-applications/about.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/instrument-applications/advanced-guide.mddocs/instrument-applications/code-examples.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/instrument-tool-call.mddocs/integrate-frameworks/about.mddocs/integrate-frameworks/adding-scopes.mddocs/integrate-frameworks/code-examples.mddocs/integrate-frameworks/non-serializable-data.mddocs/integrate-frameworks/provider-codecs.mddocs/integrate-frameworks/provider-response-codecs.mddocs/integrate-frameworks/using-codecs.mddocs/integrate-frameworks/wrap-llm-calls.mddocs/integrate-frameworks/wrap-tool-calls.mddocs/integrations/about.mddocs/integrations/deepagents.mddocs/integrations/langchain.mddocs/integrations/langgraph.mddocs/integrations/openclaw-plugin.mddocs/nemo-flow-cli/about.mddocs/nemo-flow-cli/basic-usage.mddocs/nemo-flow-cli/claude-code.mddocs/nemo-flow-cli/codex.mddocs/nemo-flow-cli/cursor.mddocs/nemo-flow-cli/hermes.mddocs/plugins/adaptive/about.mddocs/plugins/adaptive/acg.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/configuration.mddocs/plugins/observability/about.mddocs/plugins/observability/atif.mddocs/plugins/observability/atof.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/observability/opentelemetry.mddocs/reference/api/index.mddocs/reference/api/nodejs/index.mddocs/reference/api/python/index.mddocs/reference/api/rust/index.mddocs/resources/support-and-faqs.mddocs/troubleshooting/troubleshooting-guide.mddocs/use-adaptive-optimization/about.mddocs/use-adaptive-optimization/adaptive-components.mddocs/use-adaptive-optimization/advanced-guide.mddocs/use-adaptive-optimization/code-examples.mddocs/use-adaptive-optimization/configure.mdgo/nemo_flow/README.mdpython/nemo_flow/README.md
💤 Files with no reviewable changes (12)
- docs/export-observability-data/code-examples.md
- docs/export-observability-data/basic-guide.md
- docs/export-observability-data/advanced-guide.md
- docs/use-adaptive-optimization/about.md
- docs/export-observability-data/observability-plugin.md
- docs/use-adaptive-optimization/code-examples.md
- docs/use-adaptive-optimization/advanced-guide.md
- docs/export-observability-data/about.md
- docs/export-observability-data/atif.md
- docs/use-adaptive-optimization/configure.md
- docs/export-observability-data/opentelemetry.md
- docs/use-adaptive-optimization/adaptive-components.md
Signed-off-by: Will Killian <wkillian@nvidia.com>
Signed-off-by: Will Killian <wkillian@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 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/plugins/adaptive/acg.md`:
- Around line 87-88: The closing tab markers ':::' for tab-item blocks lack the
required blank line before them; update the document to insert a single blank
line immediately before each closing ':::' that ends a tab-item (e.g., the
occurrences that currently close tab sections around the blocks shown in the
diff) so that fenced code blocks and following content are separated by an empty
line as per Markdown best practices.
- Around line 186-187: Add a blank line immediately before each closing tab
marker ':::' in the Adaptive ACG docs (the same formatting used in the "Plugin
Configuration" section); locate the tab blocks that end with ':::' (the closing
tab markers around the content flagged) and insert a single empty line directly
above each ':::' so the closing marker is separated by a blank line from the
preceding content.
- Around line 15-17: The heading "## `plugins.toml` Example" is followed
immediately by a code block; add a complete introductory sentence between the
heading and the ```toml``` block that briefly explains what the configuration
demonstrates (e.g., "The following plugins.toml example shows a minimal plugin
configuration for enabling adaptive ACG settings."). Place this sentence
directly above the code fence so the code block is introduced per the coding
guidelines.
- Around line 231-233: Add a complete lead-in sentence between the "## Fields"
heading and the table to describe what configuration settings the table
documents (e.g., "The table below documents each configuration field for the ACG
plugin, its default value, and any relevant notes."). Update the paragraph near
the "## Fields" heading so it clearly introduces the table of fields, defaults,
and notes referenced by the table.
In `@docs/plugins/adaptive/adaptive-hints.md`:
- Line 84: In the MyST tab sections of docs/plugins/adaptive/adaptive-hints.md
the closing code-fence (```) is immediately followed by the tab block closure
(:::) which violates MD031; for each flagged location (the occurrences where a
``` is followed by :::) insert a single blank line between the closing
triple-backticks and the following ::: so the sequence becomes ``` [blank line]
:::, ensuring each tab block has the required blank-line separation.
In `@docs/plugins/adaptive/configuration.md`:
- Line 132: Fix the markdown MD031 blank-line violations by ensuring every
fenced code block ("```") inside the tabbed/container blocks (":::") is
surrounded by a blank line: add a blank line before the opening "```" and
another blank line after the closing "```" (i.e., change "...::: \n```" to
"...::: \n\n```" and "```\n:::" to "```\n\n:::"). Apply this pattern at each
flagged location where fenced blocks appear within the ":::" tab sections so
markdownlint no longer reports MD031.
🪄 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: ed4b6a99-7b13-4e47-8be8-8daa636aa48b
⛔ Files ignored due to path filters (1)
third_party/README-openclaw.mdis excluded by!third_party/**
📒 Files selected for processing (9)
docs/plugins/adaptive/acg.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/configuration.mddocs/plugins/observability/atif.mddocs/plugins/observability/atof.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/observability/opentelemetry.mddocs/resources/support-and-faqs.md
📜 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 (19)
**/*.{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:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.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:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst,txt}: SpellNVIDIAin all caps. Do not useNvidia,nvidia, orNV.
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 documentation.
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 documentation unless the source, platform, or legal guidance explicitly requires them.
Do not add trademark symbols to NeMo Flow learning documentation by default.
Do not rewrite API names, package names, command flags, or code literals for style reasons.
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
**/*.{md,markdown,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.{md,markdown,rst}: 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
Use monospace formatting for code elements, commands, parameters, package names, and expressions
Use monospace formatting for directories, file names, and paths
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Use quotation marks for error messages and strings in documentation
Use bold formatting for UI buttons, menus, fields, and labels in documentation
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use in documentation
Use italics for publication titles in documentation
Use plain text formatting for keyboard shortcuts in documentation
Prefer[NVIDIA/NeMo](link)format for GitHub repository references over generic phrases 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 in documentation
Avoid generic link anchors such as 'here,' 'this page,' and 'read more' in documentation
Include the acronym in link text if a linked term includes an acronym
Do not link long sentences or multiple sentences in documentation
Avoid links that pull readers away from a procedure unles...
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license headers in HTML and Markdown files using HTML comment syntax
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
docs/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run
./scripts/build-docs.shfor documentation site changes
docs/**/*.md: Relevant getting-started or reference docs must be updated when examples change
Release-policy docs must point to GitHub Releases as the only release-history source of truth
docs/**/*.md: Use title case for headings in technical documentation
Introduce code blocks, tables, and lists with complete lead-in sentences in documentation
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run Markdown link checking via
lycheeforREADME.md,CONTRIBUTING.md, anddocs/through pre-commit hooks
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
**/*.{md,markdown,py,sh,bash,js,ts,java,cpp,go,rust}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repo references, and build commands current in documentation
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
{RELEASING.md,CHANGELOG.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep release-process and release-notes guidance in repo-maintainer docs such as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
**/*.{md,markdown,py,sh,bash}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep stable user-facing wrappers at scripts/ root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
**/*.{md,markdown,py,sh,bash,js,ts,example}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Example commands must match current package names and paths
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
{scripts/*.sh,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Use root
./scripts/*.shcommands in docs and contributor guidance as documented, with implementations underscripts/third-party/
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
{docs/**,examples/**,crates/adaptive/**,python/nemo_flow/**,go/nemo_flow/**,**/{example,component}.{ts,tsx,js,rs,py,go}}
📄 CodeRabbit inference engine (.agents/skills/maintain-optimizer/SKILL.md)
Any new adaptive component kind must have documentation, examples, and binding coverage across all supported languages
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
{README*,CHANGELOG*,docs/**/*.{md,rst,txt},examples/**/*,*.md}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, and getting-started guides with new package/module/crate names after rename operations
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
**/*.{md,txt,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,txt,rst}: Ensure commands, package names, file paths, and APIs in documentation are correct and not stale; flag incorrect or outdated information as blocking issues
Ensure examples and procedures in documentation will execute successfully with current APIs and commands
Use consistent user-facing terminology throughout documentation that matches current repo terminology
Capitalize NVIDIA correctly in all documentation and public-facing text
Format code, commands, paths, and filenames as inline code (monospace) in documentation
Use descriptive anchor text for links instead of bare URLs or weak labels like 'here' in documentation
Prefer active voice, present tense, short sentences, and plain English in documentation
Structure documentation procedures as imperative steps that are easy to scan and not too long for a single sequence
Prefer 'after' instead of 'once' for temporal references in documentation
Use 'can' instead of 'may' when describing possibility (rather than permission) in documentation
Avoid ambiguous numeric dates and ordinal dates in documentation body text
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
{README.md,docs/**/*.md,examples/**/*.{js,ts,py,go,rs}}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Keep documentation and examples synchronized with current install, import, and build commands
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
**/*.{py,js,ts,tsx,go,rs,md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Format changed files with the language-native formatter before the final lint/test pass
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
{README.md,CONTRIBUTING.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For docs-only changes, run targeted checks only if commands, package names, or examples changed. Use
just docsfor docs-site builds andjust docs-linkcheckwhen links changed
Files:
docs/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
{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/plugins/adaptive/adaptive-hints.mddocs/resources/support-and-faqs.mddocs/plugins/observability/opentelemetry.mddocs/plugins/observability/atof.mddocs/plugins/observability/atif.mddocs/plugins/observability/configuration.mddocs/plugins/observability/openinference.mddocs/plugins/adaptive/configuration.mddocs/plugins/adaptive/acg.md
🪛 LanguageTool
docs/resources/support-and-faqs.md
[style] ~155-~155: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...documentation overview page to pick the right starting point for your task. ## Runti...
(REP_RIGHT)
🪛 markdownlint-cli2 (0.22.1)
docs/plugins/adaptive/adaptive-hints.md
[warning] 84-84: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 116-116: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 150-150: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 187-187: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 228-228: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
docs/plugins/adaptive/configuration.md
[warning] 132-132: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 164-164: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 209-209: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 251-251: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 297-297: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
docs/plugins/adaptive/acg.md
[warning] 87-87: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 117-117: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 151-151: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 186-186: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 226-226: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🔇 Additional comments (8)
docs/resources/support-and-faqs.md (1)
103-105: LGTM!Also applies to: 154-156, 243-243, 310-310, 324-324, 331-337, 383-386
docs/plugins/observability/opentelemetry.md (1)
1-291: LGTM!docs/plugins/observability/atof.md (1)
1-252: LGTM!docs/plugins/observability/atif.md (1)
1-268: LGTM!docs/plugins/observability/configuration.md (1)
1-319: LGTM!docs/plugins/observability/openinference.md (1)
1-298: LGTM!docs/plugins/adaptive/acg.md (2)
1-13: LGTM!
246-262: LGTM!
bbednarski9
left a comment
bbednarski9
left a comment
There was a problem hiding this comment.
LGTM some suggestions in comments
Signed-off-by: Will Killian <wkillian@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (3)
docs/plugins/adaptive/adaptive-hints.md (1)
84-84:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winMissing blank line before closing tab marker.
Same issue as previously noted: fenced code blocks in MyST tab sections require a blank line before the closing
:::.🤖 Prompt for 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. In `@docs/plugins/adaptive/adaptive-hints.md` at line 84, There is a missing blank line before the closing tab marker in the MyST tab section containing the fenced code block; edit the adaptive-hints tab block in adaptive-hints.md and ensure every fenced code block (``` ... ```) is followed by a blank line immediately before the closing tab marker (:::) so the MyST parser recognizes the block correctly.docs/plugins/adaptive/configuration.md (1)
132-132:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winMissing blank line before closing tab marker.
Same issue as previously noted: fenced code blocks in tab sections require a blank line before the closing
:::.🤖 Prompt for 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. In `@docs/plugins/adaptive/configuration.md` at line 132, The fenced code block inside the tab section is missing a blank line before the closing tab marker; update the tab content so there is an empty line between the closing triple-backticks (```) and the closing tab marker (`:::`) to ensure the fenced code block is properly terminated before `:::`.docs/plugins/adaptive/acg.md (1)
87-87:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winMissing blank line before closing tab marker.
Same issue as previously noted: add a blank line before the closing
:::marker.🤖 Prompt for 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. In `@docs/plugins/adaptive/acg.md` at line 87, The markdown tab block in acg.md is missing a blank line before the closing tab marker ':::', so edit the tab section (the block that opens with ':::' and closes with ':::') and insert a single blank line immediately before the final ':::' closing marker to follow the docs formatting convention.
🤖 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/about/ecosystem.md`:
- Line 34: Remove the stray standalone "34" editing artifact from the markdown
so the table row for "Observability and evaluation backends" is not followed by
an extraneous line; locate the table entry containing "Observability and
evaluation backends" in docs/about/ecosystem.md and delete the single line that
only contains "34".
In `@docs/about/release-notes/highlights.md`:
- Around line 14-32: Add a single blank line after each subsection heading to
satisfy MD022: insert one empty line immediately after the headings "### NeMo
Flow CLI", "### Integrations", "### Observability", "### Security", and "###
Agent Skill Improvements" so that each heading is followed by a blank line
before its content.
In `@docs/about/release-notes/known-issues.md`:
- Around line 18-20: The markdown heading "### Fixed issues from NeMo Flow 0.1:"
is missing a blank line before the following list; insert a single blank line
immediately after that heading so the unordered list lines starting with "-" are
separated from the heading (i.e., ensure there is an empty line between the "###
Fixed issues from NeMo Flow 0.1:" heading and the first list item).
---
Duplicate comments:
In `@docs/plugins/adaptive/acg.md`:
- Line 87: The markdown tab block in acg.md is missing a blank line before the
closing tab marker ':::', so edit the tab section (the block that opens with
':::' and closes with ':::') and insert a single blank line immediately before
the final ':::' closing marker to follow the docs formatting convention.
In `@docs/plugins/adaptive/adaptive-hints.md`:
- Line 84: There is a missing blank line before the closing tab marker in the
MyST tab section containing the fenced code block; edit the adaptive-hints tab
block in adaptive-hints.md and ensure every fenced code block (``` ... ```) is
followed by a blank line immediately before the closing tab marker (:::) so the
MyST parser recognizes the block correctly.
In `@docs/plugins/adaptive/configuration.md`:
- Line 132: The fenced code block inside the tab section is missing a blank line
before the closing tab marker; update the tab content so there is an empty line
between the closing triple-backticks (```) and the closing tab marker (`:::`) to
ensure the fenced code block is properly terminated before `:::`.
🪄 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: 4d67470e-d56b-401b-9f73-8371d4a2ab49
📒 Files selected for processing (9)
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/highlights.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/related-topics.mddocs/plugins/adaptive/acg.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/configuration.mddocs/plugins/observability/configuration.md
💤 Files with no reviewable changes (1)
- docs/about/release-notes/related-topics.md
📜 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 (21)
**/*.{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:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.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:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst,txt}: SpellNVIDIAin all caps. Do not useNvidia,nvidia, orNV.
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 documentation.
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 documentation unless the source, platform, or legal guidance explicitly requires them.
Do not add trademark symbols to NeMo Flow learning documentation by default.
Do not rewrite API names, package names, command flags, or code literals for style reasons.
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
**/*.{md,markdown,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.{md,markdown,rst}: 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
Use monospace formatting for code elements, commands, parameters, package names, and expressions
Use monospace formatting for directories, file names, and paths
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Use quotation marks for error messages and strings in documentation
Use bold formatting for UI buttons, menus, fields, and labels in documentation
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use in documentation
Use italics for publication titles in documentation
Use plain text formatting for keyboard shortcuts in documentation
Prefer[NVIDIA/NeMo](link)format for GitHub repository references over generic phrases 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 in documentation
Avoid generic link anchors such as 'here,' 'this page,' and 'read more' in documentation
Include the acronym in link text if a linked term includes an acronym
Do not link long sentences or multiple sentences in documentation
Avoid links that pull readers away from a procedure unles...
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license headers in HTML and Markdown files using HTML comment syntax
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
docs/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run
./scripts/build-docs.shfor documentation site changes
docs/**/*.md: Relevant getting-started or reference docs must be updated when examples change
Release-policy docs must point to GitHub Releases as the only release-history source of truth
docs/**/*.md: Use title case for headings in technical documentation
Introduce code blocks, tables, and lists with complete lead-in sentences in documentation
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run Markdown link checking via
lycheeforREADME.md,CONTRIBUTING.md, anddocs/through pre-commit hooks
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
**/*.{md,markdown,py,sh,bash,js,ts,java,cpp,go,rust}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repo references, and build commands current in documentation
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
{RELEASING.md,CHANGELOG.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep release-process and release-notes guidance in repo-maintainer docs such as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
**/*.{md,markdown,py,sh,bash}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep stable user-facing wrappers at scripts/ root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
**/*.{md,markdown,py,sh,bash,js,ts,example}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Example commands must match current package names and paths
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
{scripts/*.sh,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Use root
./scripts/*.shcommands in docs and contributor guidance as documented, with implementations underscripts/third-party/
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
docs/{about/concepts/subscribers,export-observability-data/about}.md
📄 CodeRabbit inference engine (.agents/skills/maintain-observability/SKILL.md)
Ensure examples and documentation in
docs/about/concepts/subscribers.mdanddocs/export-observability-data/about.mdreflect the same lifecycle: create, register, run, deregister, flush, shutdown
Files:
docs/about/concepts/subscribers.md
docs/{about/concepts/subscribers,export-observability-data/{about,code-examples}}.md
📄 CodeRabbit inference engine (.agents/skills/maintain-observability/SKILL.md)
Update documentation and examples in
docs/about/concepts/subscribers.md,docs/export-observability-data/about.md, anddocs/export-observability-data/code-examples.mdin the same branch when making observability changes
Files:
docs/about/concepts/subscribers.md
{docs/**,examples/**,crates/adaptive/**,python/nemo_flow/**,go/nemo_flow/**,**/{example,component}.{ts,tsx,js,rs,py,go}}
📄 CodeRabbit inference engine (.agents/skills/maintain-optimizer/SKILL.md)
Any new adaptive component kind must have documentation, examples, and binding coverage across all supported languages
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
{README*,CHANGELOG*,docs/**/*.{md,rst,txt},examples/**/*,*.md}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, and getting-started guides with new package/module/crate names after rename operations
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
**/*.{md,txt,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,txt,rst}: Ensure commands, package names, file paths, and APIs in documentation are correct and not stale; flag incorrect or outdated information as blocking issues
Ensure examples and procedures in documentation will execute successfully with current APIs and commands
Use consistent user-facing terminology throughout documentation that matches current repo terminology
Capitalize NVIDIA correctly in all documentation and public-facing text
Format code, commands, paths, and filenames as inline code (monospace) in documentation
Use descriptive anchor text for links instead of bare URLs or weak labels like 'here' in documentation
Prefer active voice, present tense, short sentences, and plain English in documentation
Structure documentation procedures as imperative steps that are easy to scan and not too long for a single sequence
Prefer 'after' instead of 'once' for temporal references in documentation
Use 'can' instead of 'may' when describing possibility (rather than permission) in documentation
Avoid ambiguous numeric dates and ordinal dates in documentation body text
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
{README.md,docs/**/*.md,examples/**/*.{js,ts,py,go,rs}}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Keep documentation and examples synchronized with current install, import, and build commands
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
**/*.{py,js,ts,tsx,go,rs,md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Format changed files with the language-native formatter before the final lint/test pass
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
{README.md,CONTRIBUTING.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For docs-only changes, run targeted checks only if commands, package names, or examples changed. Use
just docsfor docs-site builds andjust docs-linkcheckwhen links changed
Files:
docs/about/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
{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/concepts/subscribers.mddocs/about/ecosystem.mddocs/about/release-notes/known-issues.mddocs/about/release-notes/highlights.mddocs/plugins/adaptive/adaptive-hints.mddocs/plugins/adaptive/acg.mddocs/plugins/observability/configuration.mddocs/plugins/adaptive/configuration.md
🪛 markdownlint-cli2 (0.22.1)
docs/about/release-notes/known-issues.md
[warning] 18-18: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
docs/about/release-notes/highlights.md
[warning] 14-14: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 18-18: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 22-22: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 30-30: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
docs/plugins/adaptive/adaptive-hints.md
[warning] 84-84: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 116-116: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 150-150: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 187-187: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 228-228: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
docs/plugins/adaptive/acg.md
[warning] 87-87: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 117-117: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 151-151: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 186-186: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 226-226: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
docs/plugins/adaptive/configuration.md
[warning] 132-132: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 164-164: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 209-209: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 251-251: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 297-297: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🔇 Additional comments (4)
docs/about/concepts/subscribers.md (2)
84-94: LGTM!
107-109: LGTM!docs/plugins/observability/configuration.md (1)
1-320: LGTM!docs/plugins/adaptive/configuration.md (1)
170-209: LGTM!
Signed-off-by: Will Killian <wkillian@nvidia.com>
2 participants
Overview
Reorganize the documentation entry points for NeMo Flow CLI, package installation, and supported integrations, and align terminology so public docs spell out key abbreviations before using them.
Details
Supported Integrationssidebar section underdocs/integrations/with an overview support matrix and moved OpenClaw, LangChain, LangGraph, and Deep Agents guides.Integrate into Frameworksfocused on integration-author guidance and routes end users to the supported integration pages.What Should I Read First?routing table and reorders the sidebar so NeMo Flow CLI and Supported Integrations appear before application instrumentation.0.2.0.features.codex_hooksreferences in favor of the canonical Codex hooks setting.Validation:
just docs-linkcheckjust docsgit commit -s, including docs markdown linkcheck, FFI header sync, cargo fmt, cargo clippy, cargo check, and node docstring checks.Where should the reviewer start?
Start with
docs/index.mdfor the sidebar and top-level reading-path changes, then reviewdocs/getting-started/installation.mdanddocs/integrations/about.mdfor the package and integration guidance. For terminology changes, spot-checkdocs/plugins/observability/atif.md,docs/plugins/observability/atof.md,docs/plugins/adaptive/acg.md, and the generated API source comments touched incrates/core,crates/adaptive, andcrates/node.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit
New Features
Documentation
Chores