Skip to content

docs: sync onboarding provider values - #3347

Closed
sjhddh wants to merge 1 commit into
NVIDIA:mainfrom
sjhddh:docs-sync-provider-values-20260511
Closed

docs: sync onboarding provider values#3347
sjhddh wants to merge 1 commit into
NVIDIA:mainfrom
sjhddh:docs-sync-provider-values-20260511

Conversation

@sjhddh

@sjhddh sjhddh commented May 11, 2026

Copy link
Copy Markdown

Summary

  • Update the NEMOCLAW_PROVIDER reference examples to match the current installer/onboarding provider values, including routed.
  • Update the custom endpoint note to use the current custom provider key.

Fixes #3343.

Test plan

  • git diff --check
  • Confirmed docs/reference/commands.md now lists routed and references NEMOCLAW_PROVIDER=custom for custom endpoints.

Summary by CodeRabbit

  • Documentation
    • Updated environment variable documentation for onboarding configuration, clarifying available provider keys and the specific use of NEMOCLAW_ENDPOINT_URL with custom provider settings.

Review Change Stack

@copy-pr-bot

copy-pr-bot Bot commented May 11, 2026

Copy link
Copy Markdown

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.

@coderabbitai

coderabbitai Bot commented May 11, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 2cc4366e-cc2c-4602-a2e1-18d072205ef5

📥 Commits

Reviewing files that changed from the base of the PR and between 74a09bb and bc7dd06.

📒 Files selected for processing (1)
  • docs/reference/commands.md

📝 Walkthrough

Walkthrough

The "Onboarding Configuration" environment-variable documentation was updated to reflect accurate provider keys for non-interactive onboarding and clarify that NEMOCLAW_ENDPOINT_URL is used specifically with NEMOCLAW_PROVIDER=custom.

Changes

Environment Variable Documentation

Layer / File(s) Summary
Provider Configuration Reference
docs/reference/commands.md
NEMOCLAW_PROVIDER table updated with correct provider key values for non-interactive onboarding; NEMOCLAW_ENDPOINT_URL documentation clarified to indicate usage with NEMOCLAW_PROVIDER=custom instead of the previous reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A docs update hops along so clean,
Provider keys now sync the scene—
Tables corrected, endpoints bright,
Onboarding docs set straight and right!
Build, custom, routed—all aligned,
NemoClaw's reference refined. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: sync onboarding provider values' directly summarizes the main change—updating NEMOCLAW_PROVIDER documentation to match current provider values.
Linked Issues check ✅ Passed The changes directly address issue #3343 by adding the 'routed' provider to the NEMOCLAW_PROVIDER table and updating endpoint documentation to reference NEMOCLAW_PROVIDER=custom.
Out of Scope Changes check ✅ Passed All changes are limited to docs/reference/commands.md and directly relate to fixing the NEMOCLAW_PROVIDER documentation mismatch described in issue #3343.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

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

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

@wscurran

Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this detailed PR to update the documentation for onboarding provider values. This change aims to improve the accuracy of the documentation by syncing the NEMOCLAW_PROVIDER reference examples with the current installer/onboarding provider values.


Related open issues:

1 similar comment
@wscurran

Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this detailed PR to update the documentation for onboarding provider values. This change aims to improve the accuracy of the documentation by syncing the NEMOCLAW_PROVIDER reference examples with the current installer/onboarding provider values.


Related open issues:

@cv
cv requested a review from miyoungc May 24, 2026 00:08
@cv cv added v0.0.51 and removed v0.0.51 labels May 24, 2026
@ericksoa ericksoa added v0.0.55 and removed v0.0.53 labels May 27, 2026
@jyaunches jyaunches added R3 and removed v0.0.55 labels May 29, 2026
@prekshivyas

Copy link
Copy Markdown
Collaborator

Review: docs provider-value sync — LGTM ✅

Verified both changes against origin/main (the validProviders set in src/lib/onboard/providers.ts, install.sh --help, and the NEMOCLAW_ENDPOINT_URL wiring in src/lib/onboard.ts). Accurate and correctly scoped; fully resolves #3343.

Correctness

  • Provider list matches install.sh --help exactly (install.sh:126-127), the stated parity target.
  • The old values were genuinely stale: nvidia and compatible are not in validProviders (providers.ts:177-191) nor aliases (the only relevant alias is anthropiccompatible → anthropicCompatible). Replacing them was the right call.
  • NEMOCLAW_ENDPOINT_URLcustom is correct: onboard.ts gates the env-var read on selected.key === "custom". The custom provider's internal providerName is compatible-endpoint — almost certainly the origin of the old compatible doc value — but the user-facing key is custom.

Intentional omissions (not defects)

The list omits hermesProvider, install-vllm, install-ollama, install-windows-ollama, start-windows-ollama — present in validProviders but wizard-internal/agent-specific keys also absent from install.sh --help. Keeping the user-facing subset in sync with install.sh is consistent with the issue's intent.

Minor suggestions (optional, non-blocking)

  • NEMOCLAW_ENDPOINT_URL is also consumed by anthropicCompatible (Anthropic-compatible endpoints). The note only covers the custom/OpenAI-compatible case — accurate but not exhaustive. Could add: "…or NEMOCLAW_PROVIDER=anthropicCompatible for an Anthropic-compatible endpoint."
  • install.sh --help documents the aliases cloud → build and nim → nim-local; the table doesn't. Adding them would help users, though it's beyond this issue's scope.

No runtime impact (docs-only); git diff --check test plan is appropriate. Nice cleanup.

@prekshivyas

Copy link
Copy Markdown
Collaborator

@sjhddh pls resolve conflicts so that @miyoungc can review and merge this on !

@cv cv added v0.0.57 and removed v0.0.56 labels Jun 1, 2026
@cv

cv commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator

Salvage update for current main:

I rebased the docs fix onto the current repo shape, where the reference page now lives at docs/reference/commands.mdx, and pushed the salvaged one-line fix here:

https://github.com/NVIDIA/NemoClaw/tree/codex/sync-provider-docs-3347

The salvaged row changes the stale NEMOCLAW_PROVIDER=compatible wording to the current provider keys and also notes that NEMOCLAW_ENDPOINT_URL is used for both NEMOCLAW_PROVIDER=custom and NEMOCLAW_PROVIDER=anthropicCompatible, matching the current onboarding code.

I could not update this PR's fork branch directly from my token: the fork reports only READ permission for this account, and the GitHub API write attempt returned 403. The original PR therefore remains conflicted, but the maintainer-owned salvage branch is clean against current main.

Validation run on the salvage branch:

git diff --check origin/main...HEAD
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx --dry-run

check-gates.ts 3347 still reports this PR as blocked by DIRTY merge state and stale failed/cancelled checks on the old fork commit; CodeRabbit and risky-code gates are clear.

@cv cv mentioned this pull request Jun 2, 2026
12 tasks
@cv

cv commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator

Closing as superseded by #4625, which carries the same docs fix rebased onto current main and the migrated docs/reference/commands.mdx path. The original fork branch is still conflicted and could not be updated from this token.

@cv cv closed this Jun 2, 2026
cv added a commit that referenced this pull request Jun 2, 2026
## Summary
Updates the onboarding configuration reference to remove the stale
`NEMOCLAW_PROVIDER=compatible` wording. The replacement text points
users to the current `custom` and `anthropicCompatible` provider keys
for custom endpoint URLs.

## Related Issue
Supersedes #3347; follow-up to #3343.

## Changes
- Update `docs/reference/commands.mdx` so `NEMOCLAW_ENDPOINT_URL`
documents the current compatible endpoint provider keys.
- Preserve the current MDX reference page and avoid regenerating user
skill output outside release prep.

## Type of Change

- [ ] Code change (feature, bug fix, or refactor)
- [ ] Code change with doc updates
- [x] Doc only (prose changes, no code sample modifications)
- [ ] Doc only (includes code sample changes)

## Verification
- [ ] `npx prek run --all-files` passes
- [ ] `npm test` passes
- [ ] Tests added or updated for new or changed behavior
- [x] No secrets, API keys, or credentials committed
- [x] Docs updated for user-facing behavior changes
- [ ] `npm run docs` builds without warnings (doc changes only)
- [x] Doc pages follow the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md)
(doc changes only)
- [ ] New doc pages include SPDX header and frontmatter (new pages only)

Notes: `git diff --check origin/main...HEAD` passed. `python3
scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user
--doc-platform fern-mdx --dry-run` passed. `npm run docs` exited
successfully, but Fern reported 2 warnings, so the no-warnings box is
left unchecked. `npx prek run --all-files` could not complete in this
environment because the launcher hit a certificate-chain error, and the
standalone cached `prek` failed cloning `shellcheck-py` with GitHub HTTP
503.

---
Signed-off-by: Carlos Villela <cvillela@nvidia.com>

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated environment variable reference documentation to clarify
endpoint configuration options, including support for custom endpoints
and Anthropic-compatible providers.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Carlos Villela <cvillela@nvidia.com>
@wscurran wscurran added the area: cli Command line interface, flags, terminal UX, or output label Jun 3, 2026
@wscurran wscurran added bug-fix PR fixes a bug or regression area: docs Documentation, examples, guides, or docs build and removed NemoClaw CLI labels Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: cli Command line interface, flags, terminal UX, or output area: docs Documentation, examples, guides, or docs build bug-fix PR fixes a bug or regression

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Linux][Docs] commands.md NEMOCLAW_PROVIDER table missing "routed" value — install.sh lists it but docs omit it

6 participants