docs: Add FAQ section for common questions about NeMo Agent Toolkit#1930
docs: Add FAQ section for common questions about NeMo Agent Toolkit#1930meichuanyi wants to merge 1 commit into
Conversation
WalkthroughThis PR adds a comprehensive Frequently Asked Questions section to the README, covering NAT's core purpose, feature capabilities, deployment considerations, and community resources. The FAQ is organized into foundational concepts, technical feature descriptions, and production guidance topics. ChangesREADME FAQ Section
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Comment |
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`:
- Line 174: Replace narrative uses of the acronym "NAT" with the full name "NeMo
Agent Toolkit" (or "the toolkit" where concise) and only use the lowercase
backticked form `nat` for package names or code/CLI identifiers; update every
prose occurrence of "NAT" in the README (including the sentence currently using
"NAT" in the description of the toolkit) to follow this rule and keep
capitalization and punctuation consistent.
🪄 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: CHILL
Plan: Enterprise
Run ID: 22ba785f-849c-4597-8e6b-5f68ebe0d311
📒 Files selected for processing (1)
README.md
|
|
||
| ### What is NVIDIA NeMo Agent Toolkit? | ||
|
|
||
| NVIDIA NeMo Agent Toolkit (NAT) is an enterprise-grade toolkit that adds intelligence to AI agents across any framework—enhancing speed, accuracy, and decision-making through instrumentation, observability, and continuous learning. It works side-by-side with popular frameworks like LangChain, LlamaIndex, CrewAI, Microsoft Semantic Kernel, and Google ADK. |
There was a problem hiding this comment.
Replace NAT acronym usage in prose to satisfy docs lint rules.
NAT appears in narrative text in several places; this violates the Markdown vocabulary/style rules and may fail Vale. Use “NeMo Agent Toolkit” (or “the toolkit”), and reserve lowercase backticked nat only for technical identifiers/CLI references.
As per coding guidelines, “Documentation in Markdown files should not use NAT as an acronym… The exception to this rule is when referring to package names or code identifiers that contain "nat", these should always be surrounded by backticks…and be lowercase.”
Also applies to: 181-181, 257-257, 264-264, 287-287
🤖 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 `@README.md` at line 174, Replace narrative uses of the acronym "NAT" with the
full name "NeMo Agent Toolkit" (or "the toolkit" where concise) and only use the
lowercase backticked form `nat` for package names or code/CLI identifiers;
update every prose occurrence of "NAT" in the README (including the sentence
currently using "NAT" in the description of the toolkit) to follow this rule and
keep capitalization and punctuation consistent.
This PR adds a comprehensive FAQ section to the README covering:
The FAQ helps users quickly find answers to common questions about this enterprise-grade agent toolkit.
Summary by CodeRabbit
Release Notes