Skip to content

fix: correct file paths in evaluate documentation#1024

Merged
rapids-bot[bot] merged 1 commit intoNVIDIA:release/1.3from
willkill07:wkk_fix-evaluate-file-paths
Oct 17, 2025
Merged

fix: correct file paths in evaluate documentation#1024
rapids-bot[bot] merged 1 commit intoNVIDIA:release/1.3from
willkill07:wkk_fix-evaluate-file-paths

Conversation

@willkill07
Copy link
Member

@willkill07 willkill07 commented Oct 17, 2025

Description

This is an artifact of the examples reorg from NAT 1.2

Closes

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation
    • Updated file paths in evaluation documentation examples to reflect the current project structure, ensuring users can execute provided code examples without path-related errors.

Signed-off-by: Will Killian <wkillian@nvidia.com>
@willkill07 willkill07 self-assigned this Oct 17, 2025
@willkill07 willkill07 requested a review from a team as a code owner October 17, 2025 12:02
@willkill07 willkill07 added doc Improvements or additions to documentation non-breaking Non-breaking change labels Oct 17, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 17, 2025

Walkthrough

Documentation file updated with file path corrections in shell command blocks, changing example paths from examples/getting_started to examples/evaluation_and_profiling for copy and nat eval commands without modifying runtime behavior.

Changes

Cohort / File(s) Summary
Documentation path updates
docs/source/reference/evaluate.md
Updated file paths in shell command blocks from examples/getting_started to examples/evaluation_and_profiling in copy and nat eval command examples

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "fix: correct file paths in evaluate documentation" meets all specified requirements. It is concise at 49 characters (well under the ~72 character limit), uses imperative mood with the verb "correct," and is fully descriptive of the actual changes. The title directly corresponds to the main changeset, which updates file paths in docs/source/reference/evaluate.md from legacy examples/getting_started paths to the current examples/evaluation_and_profiling paths, exactly as described in the PR objectives regarding fixing documentation artifacts from the NAT 1.2 reorganization.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 15254eb and de1453d.

📒 Files selected for processing (1)
  • docs/source/reference/evaluate.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
docs/source/**/*.md

📄 CodeRabbit inference engine (.cursor/rules/general.mdc)

docs/source/**/*.md: Use the official naming throughout documentation: first use “NVIDIA NeMo Agent toolkit”, subsequent “NeMo Agent toolkit”; never use deprecated names (Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq)
Documentation sources are Markdown files under docs/source; images belong in docs/source/_static
Keep docs in sync with code; documentation pipeline must pass Sphinx and link checks; avoid TODOs/FIXMEs/placeholders; avoid offensive/outdated terms; ensure spelling correctness
Do not use words listed in ci/vale/styles/config/vocabularies/nat/reject.txt; accepted terms in accept.txt are allowed

Files:

  • docs/source/reference/evaluate.md
**/*

⚙️ CodeRabbit configuration file

**/*: # Code Review Instructions

  • Ensure the code follows best practices and coding standards. - For Python code, follow
    PEP 20 and
    PEP 8 for style guidelines.
  • Check for security vulnerabilities and potential issues. - Python methods should use type hints for all parameters and return values.
    Example:
    def my_function(param1: int, param2: str) -> bool:
        pass
  • For Python exception handling, ensure proper stack trace preservation:
    • When re-raising exceptions: use bare raise statements to maintain the original stack trace,
      and use logger.error() (not logger.exception()) to avoid duplicate stack trace output.
    • When catching and logging exceptions without re-raising: always use logger.exception()
      to capture the full stack trace information.

Documentation Review Instructions - Verify that documentation and comments are clear and comprehensive. - Verify that the documentation doesn't contain any TODOs, FIXMEs or placeholder text like "lorem ipsum". - Verify that the documentation doesn't contain any offensive or outdated terms. - Verify that documentation and comments are free of spelling mistakes, ensure the documentation doesn't contain any

words listed in the ci/vale/styles/config/vocabularies/nat/reject.txt file, words that might appear to be
spelling mistakes but are listed in the ci/vale/styles/config/vocabularies/nat/accept.txt file are OK.

Misc. - All code (except .mdc files that contain Cursor rules) should be licensed under the Apache License 2.0,

and should contain an Apache License 2.0 header comment at the top of each file.

  • Confirm that copyright years are up-to date whenever a file is changed.

Files:

  • docs/source/reference/evaluate.md
docs/source/**/*

⚙️ CodeRabbit configuration file

This directory contains the source code for the documentation. All documentation should be written in Markdown format. Any image files should be placed in the docs/source/_static directory.

Files:

  • docs/source/reference/evaluate.md
⏰ 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: CI Pipeline / Check
🔇 Additional comments (2)
docs/source/reference/evaluate.md (2)

192-192: Verify whether line 192 should be updated to the reorganized path structure.

Line 192 still references examples/getting_started/simple_calculator/..., which appears inconsistent with the path reorganization fix applied elsewhere in this PR. All other similar file references use examples/evaluation_and_profiling/.... Clarify whether this path is intentionally excluded from the update or if it should also be corrected to examples/evaluation_and_profiling/simple_calculator_eval/....


397-398: Path updates in shell command blocks are correct.

The changes to lines 397, 404, and 407 correctly update file paths from the old examples/getting_started/ structure to the reorganized examples/evaluation_and_profiling/ structure, consistent with the NAT 1.2 reorganization referenced in the PR objective.

Also applies to: 404-407


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@willkill07
Copy link
Member Author

/merge

@rapids-bot rapids-bot bot merged commit f7e1120 into NVIDIA:release/1.3 Oct 17, 2025
17 checks passed
@willkill07 willkill07 deleted the wkk_fix-evaluate-file-paths branch October 23, 2025 18:16
rapids-bot bot pushed a commit that referenced this pull request Feb 25, 2026
False positives from the markdown link checker in CI on the CHANGELOG.md file has been annoying and unhelpful. Adding CHANGELOG.md to the markdown link checker pre-commit will save us some failed CIs.


Here's an example:

```
(node:10223) [DEP0184] DeprecationWarning: Instantiating Gunzip without the 'new' keyword has been deprecated.
(Use `node --trace-deprecation ...` to show where the warning was created)

  ERROR: 3 dead links found in CHANGELOG.md !
  [✖] #1024 → Status: 502
  [✖] https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/release/1.2/docs/source/extend/object-store.md → Status: 502
  [✖] #110 → Status: 502
(node:10225) [DEP0184] DeprecationWarning: Instantiating Gunzip without the 'new' keyword has been deprecated.
(Use `node --trace-deprecation ...` to show where the warning was created)
(node:10224) [DEP0184] DeprecationWarning: Instantiating Gunzip without the 'new' keyword has been deprecated.
(Use `node --trace-deprecation ...` to show where the warning was created)
(node:10226) [DEP0184] DeprecationWarning: Instantiating Gunzip without the 'new' keyword has been deprecated.
(Use `node --trace-deprecation ...` to show where the warning was created)
```

Closes

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing/index.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.




## Summary by CodeRabbit

* **Chores**
  * Updated the markdown link-check pre-commit hook configuration to exclude the changelog file from link validation. This addition complements existing exclusions for package metadata documentation, improving the efficiency of continuous integration validation processes.

Authors:
  - Bryan Bednarski (https://github.com/bbednarski9)

Approvers:
  - Will Killian (https://github.com/willkill07)

URL: #1653
Charlie-Yi-2002 pushed a commit to Charlie-Yi-2002/NeMo-Agent-Toolkit that referenced this pull request Mar 5, 2026
False positives from the markdown link checker in CI on the CHANGELOG.md file has been annoying and unhelpful. Adding CHANGELOG.md to the markdown link checker pre-commit will save us some failed CIs.


Here's an example:

```
(node:10223) [DEP0184] DeprecationWarning: Instantiating Gunzip without the 'new' keyword has been deprecated.
(Use `node --trace-deprecation ...` to show where the warning was created)

  ERROR: 3 dead links found in CHANGELOG.md !
  [✖] NVIDIA#1024 → Status: 502
  [✖] https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/release/1.2/docs/source/extend/object-store.md → Status: 502
  [✖] NVIDIA#110 → Status: 502
(node:10225) [DEP0184] DeprecationWarning: Instantiating Gunzip without the 'new' keyword has been deprecated.
(Use `node --trace-deprecation ...` to show where the warning was created)
(node:10224) [DEP0184] DeprecationWarning: Instantiating Gunzip without the 'new' keyword has been deprecated.
(Use `node --trace-deprecation ...` to show where the warning was created)
(node:10226) [DEP0184] DeprecationWarning: Instantiating Gunzip without the 'new' keyword has been deprecated.
(Use `node --trace-deprecation ...` to show where the warning was created)
```

Closes

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing/index.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.




## Summary by CodeRabbit

* **Chores**
  * Updated the markdown link-check pre-commit hook configuration to exclude the changelog file from link validation. This addition complements existing exclusions for package metadata documentation, improving the efficiency of continuous integration validation processes.

Authors:
  - Bryan Bednarski (https://github.com/bbednarski9)

Approvers:
  - Will Killian (https://github.com/willkill07)

URL: NVIDIA#1653
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants