docs: relocate the langchain and langgraph integration documents#99
Conversation
Signed-off-by: David Gardner <dagardner@nvidia.com>
…s dir Signed-off-by: David Gardner <dagardner@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📜 Recent review details🧰 Additional context used📓 Path-based instructions (15)**/*.{md,rst,html,txt}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Files:
**/*.{md,rst,html}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Files:
**/*.{md,rst,txt}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Files:
**/*.{md,markdown,rst}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
Files:
**/*.{html,md}📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
**/README.md📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
**/*.md📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
**/*.{md,markdown,py,sh,bash,js,ts,java,cpp,go,rust}📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Files:
**/*.{md,markdown,py,sh,bash}📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Files:
**/*.{md,markdown,py,sh,bash,js,ts,example}📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Files:
{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)
Files:
**/*.{md,txt,rst}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Files:
{README.md,docs/index.md,**/README.md}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Files:
**/*.{py,js,ts,tsx,go,rs,md}📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
python/nemo_flow/**/*⚙️ CodeRabbit configuration file
Files:
🔇 Additional comments (2)
WalkthroughPython quick-start reorganized into an index with a Framework Integrations toctree; cross-document Python Quick Start links updated; LangChain and LangGraph guides revised (installation, examples, observability links); README adds optional integration extras and lists integration modules. ChangesDocumentation Restructuring and Navigation Updates
Integration Guide Updates
README Integration Documentation
🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Signed-off-by: David Gardner <dagardner@nvidia.com>
…er python Signed-off-by: David Gardner <dagardner@nvidia.com>
…docs Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
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/getting-started/python/langchain.md`:
- Around line 78-79: Add a blank line after the "Observability" markdown heading
so the heading is followed by an empty line before the paragraph; locate the
"Observability" heading in langchain.md and insert a single newline between "##
Observability" and the paragraph that starts "Refer to [Export Observability
Data]..." to ensure proper Markdown rendering.
In `@docs/getting-started/python/langgraph.md`:
- Around line 93-94: The "Observability" heading in
docs/getting-started/python/langgraph.md is missing a blank line before its
paragraph; update the markdown under the "## Observability" heading by inserting
a single blank line between the heading line and the following sentence ("Refer
to [Export Observability Data](../../export-observability-data/about.md) for
details...") so the heading is properly separated from its content.
In `@python/nemo_flow/README.md`:
- Around line 67-68: The README.md has Markdown headings missing the required
blank line after the heading (MD022); locate headings such as "LangChain
Integration" (and the other subsection headings nearby) and insert a single
blank line immediately following each heading so the heading is separated from
the next paragraph or list; ensure every Markdown heading in that area has
exactly one empty line below it to satisfy MD022 across the affected
subsections.
- Around line 94-107: The shell examples use unquoted package extras (e.g.,
nemo-flow[langchain-nvidia] and nemo-flow[langgraph,langchain-nvidia]) which can
be interpreted as glob patterns by many shells; update the README examples to
wrap the package spec strings in single or double quotes (e.g.,
'nemo-flow[langchain-nvidia]' and 'nemo-flow[langgraph,langchain-nvidia]') in
both the uv add and pip install command examples so the brackets are not
expanded by the shell.
🪄 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: c0e834d8-d12b-44b6-bf16-d28afbb27f8f
📒 Files selected for processing (12)
docs/export-observability-data/basic-guide.mddocs/getting-started/python/index.mddocs/getting-started/python/langchain.mddocs/getting-started/python/langgraph.mddocs/getting-started/quick-start.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/instrument-tool-call.mddocs/integrate-frameworks/about.mddocs/reference/api/python/index.mddocs/resources/support-and-faqs.mdpython/nemo_flow/README.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: Documentation / Build
🧰 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:
docs/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license headers in HTML and Markdown files using HTML comment syntax
Files:
docs/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run Markdown link checking via
lycheeforREADME.md,CONTRIBUTING.md, anddocs/through pre-commit hooks
Files:
docs/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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.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/integrate-frameworks/about.mddocs/reference/api/python/index.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mdpython/nemo_flow/README.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/integrate-frameworks/about.mddocs/reference/api/python/index.mddocs/instrument-applications/instrument-tool-call.mddocs/instrument-applications/instrument-llm-call.mddocs/instrument-applications/adding-scopes-and-marks.mddocs/export-observability-data/basic-guide.mddocs/resources/support-and-faqs.mddocs/getting-started/quick-start.mddocs/getting-started/python/index.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.md
docs/reference/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant reference documentation for any public API changes
Files:
docs/reference/api/python/index.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:
python/nemo_flow/README.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:
python/nemo_flow/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
🪛 markdownlint-cli2 (0.22.1)
python/nemo_flow/README.md
[warning] 67-67: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 78-78: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 89-89: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 145-145: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
docs/getting-started/python/langgraph.md
[warning] 93-93: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
docs/getting-started/python/langchain.md
[warning] 78-78: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🔇 Additional comments (15)
docs/export-observability-data/basic-guide.md (1)
25-25: LGTM!docs/reference/api/python/index.md (1)
67-67: LGTM!docs/getting-started/quick-start.md (1)
13-13: LGTM!docs/instrument-applications/adding-scopes-and-marks.md (1)
20-20: LGTM!docs/resources/support-and-faqs.md (1)
123-124: LGTM!docs/instrument-applications/instrument-tool-call.md (1)
24-24: LGTM!docs/integrate-frameworks/about.md (1)
32-35: LGTM!docs/instrument-applications/instrument-llm-call.md (1)
25-25: LGTM!docs/getting-started/python/index.md (2)
8-10: LGTM!
136-146: LGTM!docs/getting-started/python/langgraph.md (2)
6-6: 💤 Low valueVerify product name on first mention.
The heading uses "NeMo Flow" without the "NVIDIA" prefix. As per coding guidelines, NVIDIA product names should be preceded by
NVIDIAon first mention when natural and accurate. Confirm whether this should be "NVIDIA NeMo Flow LangGraph Integration".As per coding guidelines: "Precede NVIDIA product names with
NVIDIAon first mention when it is natural and accurate."
8-27: LGTM!docs/getting-started/python/langchain.md (3)
6-6: 💤 Low valueVerify product name on first mention.
The heading uses "NeMo Flow" without the "NVIDIA" prefix. As per coding guidelines, NVIDIA product names should be preceded by
NVIDIAon first mention when natural and accurate. Confirm whether this should be "NVIDIA NeMo Flow LangChain Integration".As per coding guidelines: "Precede NVIDIA product names with
NVIDIAon first mention when it is natural and accurate."
8-34: LGTM!
46-52: LGTM!Also applies to: 70-72
willkill07
left a comment
There was a problem hiding this comment.
Conditionally approving, but feedback needs to be addressed before merge
…ependencies Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
python/nemo_flow/README.md (3)
105-107:⚠️ Potential issue | 🟠 Major | ⚡ Quick winQuote package extras in shell commands.
The package extras at lines 105 and 107 are unquoted. In many shells, square brackets are glob patterns and can break the installation command.
🔧 Proposed fix
# With uv -uv add nemo-flow[langgraph,langchain-nvidia] +uv add "nemo-flow[langgraph,langchain-nvidia]" # With pip -pip install nemo-flow[langgraph,langchain-nvidia] +pip install "nemo-flow[langgraph,langchain-nvidia]"As per coding guidelines, "Ensure examples and procedures in documentation will execute successfully with current APIs and commands."
🤖 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 `@python/nemo_flow/README.md` around lines 105 - 107, The README commands use unquoted package extras which can be interpreted as shell globs; update both occurrences of the package spec so the extras are quoted (e.g. "nemo-flow[langgraph,langchain-nvidia]") in the uv and pip install examples to ensure the shell treats the brackets literally; search for the literal nemo-flow[langgraph,langchain-nvidia] in README.md and replace with the quoted form in both install lines.
79-80:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd blank line after heading.
The heading at line 79 needs a blank line before the paragraph content at line 80 to comply with MD022.
📝 Proposed fix
#### LangGraph Integration + [LangGraph](https://www.langchain.com/langgraph) integration is available with the `langgraph` extra, this builds upon and includes the `langchain` extra as well.As per coding guidelines, "Use title case consistently for headings in technical documentation" and headings should be properly spaced.
🤖 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 `@python/nemo_flow/README.md` around lines 79 - 80, Add a blank line between the "#### LangGraph Integration" heading and the following paragraph so the heading is separated per MD022, and ensure the heading uses consistent title case (e.g., "LangGraph Integration") if any edits are made to wording; update the README.md section containing the "LangGraph Integration" heading accordingly.
90-91:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd blank line after heading.
The heading at line 90 needs a blank line before the paragraph content at line 91 to comply with MD022.
📝 Proposed fix
#### LangChain NVIDIA Integration + The [LangChain NVIDIA](https://github.com/langchain-ai/langchain-nvidia) extra builds upon the `langchain` extra adding a compatible version of the `langchain-nvidia-ai-endpoints` package.As per coding guidelines, headings should be properly spaced in documentation.
🤖 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 `@python/nemo_flow/README.md` around lines 90 - 91, The heading "LangChain NVIDIA Integration" is missing a blank line after it; edit the README section containing that heading and insert a single blank line between the heading line ("LangChain NVIDIA Integration") and the following paragraph so the markdown complies with MD022 and renders correctly.
🤖 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 `@python/nemo_flow/README.md`:
- Around line 146-148: The "### Integrations" heading lacks a blank line before
the subsequent list; edit the README so there is an empty line immediately after
the "### Integrations" heading (before the `- ` list items referencing
`nemo_flow.integrations.langchain` and `nemo_flow.integrations.langgraph`) to
satisfy MD022.
---
Duplicate comments:
In `@python/nemo_flow/README.md`:
- Around line 105-107: The README commands use unquoted package extras which can
be interpreted as shell globs; update both occurrences of the package spec so
the extras are quoted (e.g. "nemo-flow[langgraph,langchain-nvidia]") in the uv
and pip install examples to ensure the shell treats the brackets literally;
search for the literal nemo-flow[langgraph,langchain-nvidia] in README.md and
replace with the quoted form in both install lines.
- Around line 79-80: Add a blank line between the "#### LangGraph Integration"
heading and the following paragraph so the heading is separated per MD022, and
ensure the heading uses consistent title case (e.g., "LangGraph Integration") if
any edits are made to wording; update the README.md section containing the
"LangGraph Integration" heading accordingly.
- Around line 90-91: The heading "LangChain NVIDIA Integration" is missing a
blank line after it; edit the README section containing that heading and insert
a single blank line between the heading line ("LangChain NVIDIA Integration")
and the following paragraph so the markdown complies with MD022 and renders
correctly.
🪄 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: 6d3deb07-a7f6-4c1a-a129-62836f38d51c
📒 Files selected for processing (3)
docs/getting-started/python/langchain.mddocs/getting-started/python/langgraph.mdpython/nemo_flow/README.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (22)
**/*.{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:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license headers in HTML and Markdown files using HTML comment syntax
Files:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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:
python/nemo_flow/README.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run Markdown link checking via
lycheeforREADME.md,CONTRIBUTING.md, anddocs/through pre-commit hooks
Files:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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:
python/nemo_flow/README.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:
python/nemo_flow/README.mddocs/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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
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/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/getting-started/python/langgraph.mddocs/getting-started/python/langchain.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/getting-started/python/langgraph.mddocs/getting-started/python/langchain.md
🪛 markdownlint-cli2 (0.22.1)
python/nemo_flow/README.md
[warning] 79-79: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 90-90: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 146-146: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
docs/getting-started/python/langgraph.md
[warning] 24-24: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 32-32: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 106-106: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 114-114: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
docs/getting-started/python/langchain.md
[warning] 24-24: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 32-32: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 49-49: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 57-57: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🔇 Additional comments (10)
python/nemo_flow/README.md (2)
67-77: LGTM!
65-66: LGTM!docs/getting-started/python/langchain.md (4)
8-35: LGTM!
37-60: LGTM!
72-78: LGTM!Also applies to: 96-98
104-106: LGTM!docs/getting-started/python/langgraph.md (4)
8-38: LGTM!
74-76: LGTM!
94-117: LGTM!
119-121: LGTM!
Signed-off-by: David Gardner <dagardner@nvidia.com>
|
/merge |
Overview
uv synccommands with theuv add/pip installequivalents.Details
Where should the reviewer start?
Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit