Perform vale spelling checks on notebooks

[dagardner-nv]

Description

• Exports notebooks to markdown files in a temporary directory, and then runs vale on those
• Remove out of date exclusion of the nv_internal directory

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

  • Polished example notebooks: corrected wording/capitalization, standardized terminology (e.g., LlamaIndex, FastAPI), improved code/reference formatting, and clarified the GPU sizing notebook intro and notes.
  • Removed certain in-notebook execution snippets to streamline guidance.
  • Expanded documentation vocabulary to reduce linting false positives.

• Chores

  • Documentation linting now includes converted notebooks for more comprehensive checks.
  • Improved robustness of docs checks with clearer error handling and temporary file management.
  • Added nbconvert to development dependencies to support notebook conversion.

[coderabbitai]

Warning

Rate limit exceeded

@dagardner-nv has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 21 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between a0a354f and 5f7fc5e.

📒 Files selected for processing (2)

• ci/scripts/documentation_checks.sh (1 hunks)
• examples/notebooks/1_getting_started.ipynb (5 hunks)

Walkthrough

Adds notebook-to-Markdown conversion in documentation CI, then runs Vale on docs and converted notebooks. Updates Vale vocabulary. Edits multiple example notebooks’ markdown/text. Adds nbconvert as a dev dependency. Adjusts temp directory handling, error handling, and cleanup behavior in the CI script.

Changes

Cohort / File(s)	Summary of changes
CI docs checks flow ci/scripts/documentation_checks.sh	Introduces .ipynb discovery, converts notebooks to Markdown via jupyter nbconvert in a temp EXPORT_DIR, aggregates converted paths, and runs Vale on both docs and converted notebooks. Adds workspace-aware tmp handling, failure cleanup, and optional tmp preservation. Updates DOC_FILES exclusion rules.
Vale vocabulary ci/vale/styles/config/vocabularies/nat/accept.txt	Adds and normalizes accepted terms/regexes (e.g., configurability, reimplement, reinstall, replatform, uncomment, unencrypted).
Example notebooks — core examples/notebooks/1_getting_started.ipynb, examples/notebooks/2_add_tools_and_agents.ipynb, examples/notebooks/3_observability_evaluation_and_profiling.ipynb	Textual/formatting edits: capitalization/terminology normalization, inline code/backticks, minor wording tweaks; some execution snippet removals. No logic changes.
Example notebook — launchables examples/notebooks/launchables/GPU_Cluster_Sizing_with_NeMo_Agent_Toolkit.ipynb	Revises intro description and converts HTML note to Markdown quote. Documentation-only changes.
Dev dependency pyproject.toml	Adds nbconvert to the dev dependency group.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Developer
  participant CI as CI: documentation_checks.sh
  participant JN as jupyter nbconvert
  participant Vale as Vale

  Dev->>CI: Run documentation checks
  Note over CI: Discover DOC_FILES and NOTEBOOK_FILES
  CI->>JN: Convert *.ipynb -> Markdown (EXPORT_DIR)
  alt Conversion fails
    JN-->>CI: Non-zero exit
    CI->>CI: Cleanup EXPORT_DIR (unless preserved)
    CI-->>Dev: Exit non-zero
  else Conversion succeeds
    JN-->>CI: Converted Markdown paths
    CI->>Vale: Lint DOC_FILES + converted notebooks
    Vale-->>CI: Exit code (RETVAL)
    CI->>CI: Cleanup or preserve EXPORT_DIR
    CI-->>Dev: Return RETVAL
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 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 title “Perform vale spelling checks on notebooks” uses the imperative mood, succinctly describes the core functionality added—running Vale checks on notebook-derived Markdown—and stays well under the 72-character limit. It directly reflects the primary change in the PR by indicating the action and the target, making it clear and descriptive.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 8

📜 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 30639a0 and 682ce5c.

⛔ Files ignored due to path filters (1)

• uv.lock is excluded by !**/*.lock

📒 Files selected for processing (7)

• ci/scripts/documentation_checks.sh (1 hunks)
• ci/vale/styles/config/vocabularies/nat/accept.txt (4 hunks)
• examples/notebooks/1_getting_started.ipynb (6 hunks)
• examples/notebooks/2_add_tools_and_agents.ipynb (6 hunks)
• examples/notebooks/3_observability_evaluation_and_profiling.ipynb (2 hunks)
• examples/notebooks/launchables/GPU_Cluster_Sizing_with_NeMo_Agent_Toolkit.ipynb (2 hunks)
• pyproject.toml (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*

⚙️ 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:

• pyproject.toml
• ci/vale/styles/config/vocabularies/nat/accept.txt
• examples/notebooks/2_add_tools_and_agents.ipynb
• examples/notebooks/3_observability_evaluation_and_profiling.ipynb
• ci/scripts/documentation_checks.sh
• examples/notebooks/1_getting_started.ipynb
• examples/notebooks/launchables/GPU_Cluster_Sizing_with_NeMo_Agent_Toolkit.ipynb

examples/**/*

⚙️ CodeRabbit configuration file

examples/**/*: - This directory contains example code and usage scenarios for the toolkit, at a minimum an example should
contain a README.md or file README.ipynb.

• If an example contains Python code, it should be placed in a subdirectory named src/ and should
  contain a pyproject.toml file. Optionally, it might also contain scripts in a scripts/ directory.
• If an example contains YAML files, they should be placed in a subdirectory named configs/. - If an example contains sample data files, they should be placed in a subdirectory named data/, and should
  be checked into git-lfs.

Files:

• examples/notebooks/2_add_tools_and_agents.ipynb
• examples/notebooks/3_observability_evaluation_and_profiling.ipynb
• examples/notebooks/1_getting_started.ipynb
• examples/notebooks/launchables/GPU_Cluster_Sizing_with_NeMo_Agent_Toolkit.ipynb

{scripts/**,ci/scripts/**}

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

Shell or utility scripts belong in scripts/ or ci/scripts/ and must not be mixed with library code

Files:

• ci/scripts/documentation_checks.sh

⏰ 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 (14)

examples/notebooks/launchables/GPU_Cluster_Sizing_with_NeMo_Agent_Toolkit.ipynb (2)

9-9: LGTM!

The updated description clearly explains the notebook's purpose using proper grammar and spelling. The change from a toolkit-specific description to a generic example-based explanation improves clarity.

---

423-423: LGTM!

The conversion from HTML Bootstrap-styled alert to Markdown note format improves consistency and simplicity. The formatting is correct, and the instruction is clear.

examples/notebooks/1_getting_started.ipynb (5)

63-63: LGTM! Spelling correction applied.

The typo "resuability" has been correctly changed to "reusability" in the text.

---

185-189: LGTM! Formatting improvements for tool references.

The formatting changes consistently present FastAPI, WebSockets, and MCP with proper capitalization and inline code styling.

---

264-264: LGTM! Framework name capitalization standardized.

The change properly capitalizes "LlamaIndex" to match the official framework name.

---

276-276: LGTM! NIM capitalization correction.

The text now properly capitalizes "NIM" as an acronym/product name.

---

289-289: LGTM! Framework reference standardized.

The change to "LangChain/LangGraph's Tavily search API" properly capitalizes both framework names and uses correct possessive form.

examples/notebooks/2_add_tools_and_agents.ipynb (6)

34-34: LGTM! Path reference formatted as inline code.

The path reference has been appropriately wrapped in inline code formatting for better readability.

---

71-71: LGTM! Path reference formatted consistently.

---

119-119: LGTM! Framework name capitalized correctly.

"LlamaIndex" now matches the official product name capitalization.

---

130-130: LGTM! Technical section references formatted as inline code.

References to configuration sections (embedder and llms) are now properly formatted with inline code styling.

---

220-230: LGTM! Technical terms and identifiers formatted consistently.

All technical references (file paths, variable names like user_input_manager, AIMessage, conditional_edge, check_hitl_approval) are now properly wrapped in inline code formatting for consistency and readability.

---

261-261: LGTM! Variable reference formatted as inline code.

The user_input_manager variable reference is now properly formatted.

ci/scripts/documentation_checks.sh (1)

20-21: LGTM! File collection updated correctly.

The script now collects both Markdown/RST files and notebook files separately, excluding CHANGELOG and LICENSE as intended.

[dagardner-nv]

/merge