Skip to content

docs: restore CLI reference link (regression from #492)#702

Closed
Mirai1129 wants to merge 3 commits intoNVIDIA:mainfrom
Mirai1129:readme-fix
Closed

docs: restore CLI reference link (regression from #492)#702
Mirai1129 wants to merge 3 commits intoNVIDIA:mainfrom
Mirai1129:readme-fix

Conversation

@Mirai1129
Copy link
Copy Markdown
Contributor

@Mirai1129 Mirai1129 commented Mar 23, 2026

Summary

Restores the CLI reference link which was accidentally broken in #492.

Changes

Change .md to .html

Type of Change

  • Code change for a new feature, bug fix, or refactor.
  • Code change with doc updates.
  • Doc only. Prose changes without code sample modifications.
  • Doc only. Includes code sample changes.

Testing

  • make check passes.
  • npm test passes.
  • make docs builds without warnings. (for doc-only changes)

Checklist

General

Code Changes

  • make format applied (TypeScript and Python).
  • Tests added or updated for new or changed behavior.
  • No secrets, API keys, or credentials committed.
  • Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs).

Doc Changes

  • Follows the style guide. Try running the update-docs agent skill to draft changes while complying with the style guide. For example, prompt your agent with "/update-docs catch up the docs for the new changes I made in this PR."
  • New pages include SPDX license header and frontmatter, if creating a new page.
  • Cross-references and links verified.

Summary by CodeRabbit

  • Documentation
    • Updated the NemoClaw CLI reference link to direct users to the HTML version of the documentation for accessing all commands, flags, and options.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 23, 2026

📝 Walkthrough

Walkthrough

README.md link for the NemoClaw CLI reference was updated from markdown (.md) to HTML (.html) format, maintaining the same documentation destination while adjusting the file extension reference.

Changes

Cohort / File(s) Summary
Documentation Link Update
README.md
Updated NemoClaw CLI reference link from .../commands.md to .../commands.html format.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

documentation, NemoClaw CLI

Suggested reviewers

  • ericksoa
  • miyoungc

Poem

🐰 A link changed from .md to .html so fine,
Documentation flows in a cleaner line,
No code to break, just paths rearranged,
The CLI reference—beautifully changed! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately describes the main change: restoring a broken CLI reference link that was a regression from PR #492, which aligns with the actual modification from .md to .html.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@Mirai1129 Mirai1129 changed the title fix: restore CLI reference link (regression from #492) docs(fix): restore CLI reference link (regression from #492) Mar 23, 2026
@Mirai1129 Mirai1129 changed the title docs(fix): restore CLI reference link (regression from #492) docs: restore CLI reference link (regression from #492) Mar 23, 2026
@wscurran wscurran added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 23, 2026
@wscurran
Copy link
Copy Markdown
Contributor

Thanks for restoring the CLI reference link, this helps improve the accuracy of our documentation and makes it easier for users to get started.

@wscurran wscurran requested a review from miyoungc March 23, 2026 20:07
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc left a comment

Choose a reason for hiding this comment

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

Thank you for catching this and helping fix it. This was fixed in another PR. The latest README has the right URL:

See the full [CLI reference](https://docs.nvidia.com/nemoclaw/latest/reference/commands.html) for all commands, flags, and options.

Closing the PR.

@miyoungc miyoungc closed this Mar 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants