Skip to content

docs: sync onboarding provider values - #4625

Merged
cv merged 1 commit into
mainfrom
codex/supersede-3347-provider-docs
Jun 2, 2026
Merged

docs: sync onboarding provider values#4625
cv merged 1 commit into
mainfrom
codex/supersede-3347-provider-docs

Conversation

@cv

@cv cv commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator

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
  • 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
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (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

Summary by CodeRabbit

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

Signed-off-by: Carlos Villela <cvillela@nvidia.com>
@cv cv self-assigned this Jun 2, 2026
@copy-pr-bot

copy-pr-bot Bot commented Jun 2, 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 Jun 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 8c52626b-e892-4137-ab71-8f6d91aeec04

📥 Commits

Reviewing files that changed from the base of the PR and between 451f26f and e9e53b7.

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

📝 Walkthrough

Walkthrough

The onboarding configuration environment variable documentation is updated to clarify that NEMOCLAW_ENDPOINT_URL supports OpenAI-compatible (custom) and Anthropic-compatible (anthropicCompatible) providers, replacing the previous provider-specific description.

Changes

Environment Variable Reference

Layer / File(s) Summary
Custom endpoint URL documentation
docs/reference/commands.mdx
The NEMOCLAW_ENDPOINT_URL environment variable is documented to specify support for custom OpenAI-compatible and Anthropic-compatible endpoints in the onboarding configuration reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A tweak to the docs, so small and so bright, 🐰
Custom endpoints now documented right,
OpenAI and Anthropic paths aligned,
Documentation clarity, perfectly 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 accurately reflects the main change: updating documentation to synchronize provider values from stale 'compatible' to current 'custom' and 'anthropicCompatible' endpoint provider keys.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/supersede-3347-provider-docs

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

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

E2E Advisor Recommendation

Required E2E: None
Optional E2E: None

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

  • None. Docs-only change to reference text. It cannot affect NemoClaw runtime behavior or real user flows, so no E2E jobs are needed.

Optional E2E

  • None.

New E2E recommendations

  • None.

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

E2E Scenario Advisor Recommendation

Required scenario E2E: None
Optional scenario E2E: None

Workflow run

Full scenario advisor summary

E2E Scenario Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required scenario E2E

  • None. Docs-only change outside test/e2e-scenario/ and scenario workflow files; cannot affect scenario E2E behavior.

Optional scenario E2E

  • None.

Relevant changed files

  • None.

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor

Findings: 0 needs attention, 0 worth checking, 0 nice ideas
Since last review: 0 prior items resolved, 0 still apply, 0 new items found

Workflow run details

This is an automated advisory review. A human maintainer must make the final merge decision.

@cv
cv merged commit ef1d4af into main Jun 2, 2026
24 checks passed
@cv
cv deleted the codex/supersede-3347-provider-docs branch June 2, 2026 00:37
@wscurran wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance and removed documentation labels Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants