Skip to content

docs: broaden product naming review - #106

Closed
zhongxuanwang-nv wants to merge 1 commit into
mainfrom
docs/product-naming-guardrail
Closed

docs: broaden product naming review#106
zhongxuanwang-nv wants to merge 1 commit into
mainfrom
docs/product-naming-guardrail

Conversation

@zhongxuanwang-nv

@zhongxuanwang-nv zhongxuanwang-nv commented Jul 23, 2026

Copy link
Copy Markdown
Member

Overview

Extends NVIDIA NeMo Fabric naming review to every currently tracked path CodeRabbit can review, including dot-prefixed paths. No runtime changes.

Details

  • Broadens the path glob and removes the stale fabric CLI exception; the executable is nemo-fabric.

Validation

  • uv run pre-commit run --files .coderabbit.yaml
  • uvx check-jsonschema --schemafile https://coderabbit.ai/integrations/schema.v2.json .coderabbit.yaml
  • Minimatch audit: 382/382 tracked paths
  • YAML parse and git diff --check

Where 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

  • Documentation
    • Updated product naming guidance enforcement to consistently use “NVIDIA NeMo Fabric,” “NeMo Fabric,” and capitalize standalone “Fabric.”
  • Chores
    • Broadened automated naming review coverage to apply across the entire repository and dotfile-like patterns (not just Markdown), while preserving existing exclusions for code identifiers, symbols, configuration keys, file paths, and unrelated generic uses.

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

Updated .coderabbit.yaml so product naming guidance applies to repository-wide and dotfile-like paths, while retaining the existing exclusions and removing the explicit lowercase fabric CLI exception.

Changes

Product naming guidance

Layer / File(s) Summary
Expand repository-wide naming instructions
.coderabbit.yaml
reviews.path_instructions now targets broader repository paths, retains product naming rules and exclusions, and removes the explicit lowercase fabric CLI exception.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title follows Conventional Commits and accurately summarizes the PR's documentation-oriented review rule change.
Description check ✅ Passed The description matches the template's required sections and includes overview, review start point, issue reference, and confirmations.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/product-naming-guardrail

Comment @coderabbitai help to get the list of available commands.

@zhongxuanwang-nv
zhongxuanwang-nv force-pushed the docs/product-naming-guardrail branch from 95c2874 to cd40ec7 Compare July 23, 2026 04:25
@zhongxuanwang-nv zhongxuanwang-nv changed the title docs: harden product naming guidance docs: broaden product naming review Jul 23, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 95c2874 and cd40ec7.

📒 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; reserve fix for actual product bugs, not CI, documentation, or chores.

Files:

  • .coderabbit.yaml

Comment thread .coderabbit.yaml Outdated
Comment on lines +77 to +79
- 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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 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.

@zhongxuanwang-nv
zhongxuanwang-nv force-pushed the docs/product-naming-guardrail branch from cd40ec7 to b4deb7a Compare July 23, 2026 04:29
Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
@zhongxuanwang-nv
zhongxuanwang-nv force-pushed the docs/product-naming-guardrail branch from b4deb7a to 0383b1c Compare July 23, 2026 05:34
@zhongxuanwang-nv
zhongxuanwang-nv marked this pull request as ready for review July 23, 2026 05:39
@zhongxuanwang-nv
zhongxuanwang-nv requested a review from a team as a code owner July 23, 2026 05:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant