docs: sync onboarding provider values - #3347
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe "Onboarding Configuration" environment-variable documentation was updated to reflect accurate provider keys for non-interactive onboarding and clarify that ChangesEnvironment Variable Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Comment |
|
✨ 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 Related open issues: |
1 similar comment
|
✨ 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 Related open issues: |
Review: docs provider-value sync — LGTM ✅Verified both changes against Correctness
Intentional omissions (not defects)The list omits Minor suggestions (optional, non-blocking)
No runtime impact (docs-only); |
|
Salvage update for current I rebased the docs fix onto the current repo shape, where the reference page now lives at https://github.com/NVIDIA/NemoClaw/tree/codex/sync-provider-docs-3347 The salvaged row changes the stale I could not update this PR's fork branch directly from my token: the fork reports only 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
|
|
Closing as superseded by #4625, which carries the same docs fix rebased onto current |
## 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>
Summary
NEMOCLAW_PROVIDERreference examples to match the current installer/onboarding provider values, includingrouted.customprovider key.Fixes #3343.
Test plan
git diff --checkdocs/reference/commands.mdnow listsroutedand referencesNEMOCLAW_PROVIDER=customfor custom endpoints.Summary by CodeRabbit
NEMOCLAW_ENDPOINT_URLwith custom provider settings.