Skip to content

Docs: fix README typo, fill in CONTRIBUTING.md TODO, clean up print_env.sh#1634

Open
splint-disk-8i wants to merge 2 commits intoNVIDIA:mainfrom
splint-disk-8i:docs/fix-readme-typo
Open

Docs: fix README typo, fill in CONTRIBUTING.md TODO, clean up print_env.sh#1634
splint-disk-8i wants to merge 2 commits intoNVIDIA:mainfrom
splint-disk-8i:docs/fix-readme-typo

Conversation

@splint-disk-8i
Copy link

@splint-disk-8i splint-disk-8i commented Mar 15, 2026

A few small docs and script improvements:

  • README.md: fix double colon typo in the 'What is NeMo Retriever Library?' section
  • CONTRIBUTING.md: replace the TODO(Devin) placeholder under 'Adding a New Stage or Module' with a basic guide covering module creation, decorator usage, registration, testing, and documentation (refs [DOC]: Add process for creating a new Task handler to CONTRIBUTING.md #16)
  • scripts/support/print_env.sh: fix inconsistent section headers, add proper indentation, quote variables in printf statements to handle paths with spaces, add Docker version to the environment report

@splint-disk-8i splint-disk-8i requested a review from a team as a code owner March 15, 2026 09:39
@splint-disk-8i splint-disk-8i requested a review from nkmcalli March 15, 2026 09:39
@copy-pr-bot
Copy link

copy-pr-bot bot commented Mar 15, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

- Replace TODO(Devin) placeholder with guide on adding new stages (refs NVIDIA#16)
- Fix inconsistent headers and indentation in print_env.sh
- Quote variables in printf to handle paths with spaces
- Add Docker version to environment report
@splint-disk-8i splint-disk-8i changed the title Fix double colon typo in README Docs: fix README typo, fill in CONTRIBUTING.md TODO, clean up print_env.sh Mar 15, 2026
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