docs: broaden product naming review - #106
Conversation
WalkthroughUpdated ChangesProduct naming guidance
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
95c2874 to
cd40ec7
Compare
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 @.coderabbit.yaml:
- Around line 77-79: Update the instructions under the "**/*" path in the
configuration to explicitly allow the backticked `fabric` CLI command and
exclude CLI command names from product-name enforcement. Preserve the existing
exclusions for code and technical identifiers while ensuring valid command
examples are not flagged.
🪄 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: 2e27c51e-85eb-4ae5-b1e3-97d4c5c4b3c3
📒 Files selected for processing (1)
.coderabbit.yaml
📜 Review details
⏰ Context from checks skipped due to timeout. (18)
- GitHub Check: Pre-commit
- GitHub Check: Test (Python 3.12, linux-amd64)
- GitHub Check: Test (Python 3.13, windows-amd64)
- GitHub Check: Test (Python 3.12, windows-amd64)
- GitHub Check: Test (Python 3.12, macos-arm64)
- GitHub Check: Test (Python 3.13, linux-arm64)
- GitHub Check: Test (Python 3.14, linux-amd64)
- GitHub Check: Test (Python 3.11, windows-amd64)
- GitHub Check: Test (Python 3.14, macos-arm64)
- GitHub Check: Test (Python 3.13, macos-arm64)
- GitHub Check: Test (Python 3.12, linux-arm64)
- GitHub Check: Test (Python 3.14, windows-amd64)
- GitHub Check: Test (Python 3.14, linux-arm64)
- GitHub Check: Test (Python 3.11, macos-arm64)
- GitHub Check: Test (Python 3.11, linux-arm64)
- GitHub Check: Test (Python 3.13, linux-amd64)
- GitHub Check: Test (Python 3.11, linux-amd64)
- GitHub Check: Test (x86_64)
🧰 Additional context used
📓 Path-based instructions (1)
.coderabbit.yaml
📄 CodeRabbit inference engine (AGENTS.md)
Use Conventional Commit PR titles in the
<type>: <summary>format as required by.coderabbit.yaml; reservefixfor actual product bugs, not CI, documentation, or chores.
Files:
.coderabbit.yaml
| - path: "**/*" | ||
| instructions: | | ||
| Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercase `fabric` CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word. | ||
| Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Preserve the backticked fabric CLI exception.
Because this instruction now applies to **/*, it will also inspect command examples and user-facing CLI documentation, but it no longer states that standalone lowercase fabric is valid when referring to the CLI. Add the explicit backticked CLI exception and exclude command names so valid commands are not flagged.
🤖 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 @.coderabbit.yaml around lines 77 - 79, Update the instructions under the
"**/*" path in the configuration to explicitly allow the backticked `fabric` CLI
command and exclude CLI command names from product-name enforcement. Preserve
the existing exclusions for code and technical identifiers while ensuring valid
command examples are not flagged.
cd40ec7 to
b4deb7a
Compare
Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
b4deb7a to
0383b1c
Compare
Overview
Extends NVIDIA NeMo Fabric naming review to every currently tracked path CodeRabbit can review, including dot-prefixed paths. No runtime changes.
Details
fabricCLI exception; the executable isnemo-fabric.Validation
uv run pre-commit run --files .coderabbit.yamluvx check-jsonschema --schemafile https://coderabbit.ai/integrations/schema.v2.json .coderabbit.yamlgit diff --checkWhere should the reviewer start?
Review
.coderabbit.yaml.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Relates to refactor: slim adapter runtime dependencies #105
I confirm this contribution is my own work, or I have the right to submit it under this project's license.
I searched existing issues and open pull requests, and this does not duplicate existing work.
Summary by CodeRabbit