docs: refresh v0.0.68 release notes - #5820
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 (2)
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThe PR adds Microsoft Teams support details to messaging docs and support tables, updates release notes, and splits the sessions export reference into OpenClaw and Hermes-specific forms. ChangesMessaging support and release notes
Sessions export docs
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
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)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-pr-5820.docs.buildwithfern.com/nemoclaw |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in the Show a code coverage summary of the most covered files.
TypeScript / code-coverage/cliThe overall coverage in the Show a code coverage summary of the most covered files.
Updated |
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Vitest E2E Scenario RecommendationRequired Vitest E2E scenarios: None Full Vitest E2E advisor summaryVitest E2E Scenario AdvisorBase: Required Vitest E2E scenarios
Optional Vitest E2E scenarios
Relevant changed files
|
PR Review Advisor — No blocking findingsMerge posture: No blocking advisor findings Action checklist
Test follow-ups to resolve or justifyIf these cover changed behavior, prefer adding them in this PR; otherwise state why existing coverage is enough or link the follow-up.
This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision. |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/about/release-notes.mdx`:
- Line 26: The release note text in the docs entry uses literal values without
inline code formatting. Update the prose in the release-notes content so the
config key and command referenced by the review comment are rendered as code,
using the existing documentation style for literal values; locate the affected
sentence by the mentions of messaging_platforms and channels add.
In `@docs/manage-sandboxes/messaging-channels.mdx`:
- Around line 216-217: The Teams setup description is misleading because it
suggests token-based input. Update the `channels add` documentation text in
`messaging-channels.mdx` so the Microsoft Teams entry explicitly says it
collects an app ID, client secret, tenant ID, and optional
allowlist/webhook-port settings, and make it clear that it does not prompt for a
token; keep the wording consistent with the other channel descriptions in that
section.
In `@docs/reference/platform-support.mdx`:
- Line 120: The Microsoft Teams table entry in the platform support reference
has multiple sentences on one source line, violating the one-sentence-per-line
docs rule. Update the Teams row in the markdown table so each sentence is placed
on its own line while keeping the same content and structure, and make sure the
change is localized to the Teams row in the platform support section.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: ec9e7d93-6adb-42ab-b911-2adef16e9ded
📒 Files selected for processing (6)
ci/platform-matrix.jsondocs/about/release-notes.mdxdocs/manage-sandboxes/messaging-channels.mdxdocs/reference/commands-nemohermes.mdxdocs/reference/commands.mdxdocs/reference/platform-support.mdx
| Scripted installs propagate onboarding exit codes, interrupted installer runs start fresh when no sandbox exists to resume, and resume behavior stays tied to onboarding sessions with a real sandbox. | ||
| For more information, refer to [NemoClaw Quickstart with OpenClaw](../get-started/quickstart) and [Troubleshooting](../reference/troubleshooting). | ||
| - Messaging setup adds experimental Microsoft Teams channel onboarding for OpenClaw and Hermes, including Bot Framework credentials, webhook forwarding, the `teams` network policy preset, and local webhook port conflict checks. | ||
| NemoClaw also treats `messaging_platforms: []` as an explicit deny-all declaration and rejects `channels add` before policy, provider, registry, credential, or rebuild mutations when the selected agent does not support messaging. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Format the key and command as code.
messaging_platforms: [] and channels add are literal values here, so they need inline code formatting.
As per path instructions, commands and literal/config values in docs must use code formatting.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/about/release-notes.mdx` at line 26, The release note text in the docs
entry uses literal values without inline code formatting. Update the prose in
the release-notes content so the config key and command referenced by the review
comment are rendered as code, using the existing documentation style for literal
values; locate the affected sentence by the mentions of messaging_platforms and
channels add.
Source: Path instructions
| `channels add` collects whatever each channel needs. | ||
| It prompts for Telegram, Discord, and Slack tokens, runs an interactive host-side QR scan for WeChat, and collects nothing for WhatsApp because pairing happens in-sandbox after rebuild. | ||
| It prompts for Telegram, Discord, Slack, and Microsoft Teams tokens and configuration, runs an interactive host-side QR scan for WeChat, and collects nothing for WhatsApp because pairing happens in-sandbox after rebuild. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Describe the Teams inputs more precisely.
The Teams manifest requires an app ID, client secret, tenant ID, and optional allowlist and webhook-port settings; it does not prompt for a token. This wording makes Teams look token-based and could mislead readers during setup.
Proposed wording fix
- It prompts for Telegram, Discord, Slack, and Microsoft Teams tokens and configuration, runs an interactive host-side QR scan for WeChat, and collects nothing for WhatsApp because pairing happens in-sandbox after rebuild.
+ It prompts for Telegram, Discord, and Slack bot credentials, and for Microsoft Teams app credentials and webhook settings, runs an interactive host-side QR scan for WeChat, and collects nothing for WhatsApp because pairing happens in-sandbox after rebuild.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| `channels add` collects whatever each channel needs. | |
| It prompts for Telegram, Discord, and Slack tokens, runs an interactive host-side QR scan for WeChat, and collects nothing for WhatsApp because pairing happens in-sandbox after rebuild. | |
| It prompts for Telegram, Discord, Slack, and Microsoft Teams tokens and configuration, runs an interactive host-side QR scan for WeChat, and collects nothing for WhatsApp because pairing happens in-sandbox after rebuild. | |
| `channels add` collects whatever each channel needs. | |
| It prompts for Telegram, Discord, and Slack bot credentials, and for Microsoft Teams app credentials and webhook settings, runs an interactive host-side QR scan for WeChat, and collects nothing for WhatsApp because pairing happens in-sandbox after rebuild. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/manage-sandboxes/messaging-channels.mdx` around lines 216 - 217, The
Teams setup description is misleading because it suggests token-based input.
Update the `channels add` documentation text in `messaging-channels.mdx` so the
Microsoft Teams entry explicitly says it collects an app ID, client secret,
tenant ID, and optional allowlist/webhook-port settings, and make it clear that
it does not prompt for a token; keep the wording consistent with the other
channel descriptions in that section.
| | Telegram | Tested | Configured through an OpenShell-managed channel during onboarding. | | ||
| | WeChat | Tested with limitations | Channel hook available. Verify regional account access before relying on this path. | | ||
| | WhatsApp | Tested with limitations | Supported by both OpenClaw and Hermes (see `messaging_platforms` in `agents/openclaw/manifest.yaml` and `agents/hermes/manifest.yaml`). Pairing happens in the sandbox through WhatsApp Web by scanning a QR code at first run; the Hermes flow exposes this as `hermes whatsapp` and persists session credentials under `~/.hermes/platforms/whatsapp/session` (`agents/hermes/manifest.yaml:69-71`). Sandbox egress goes through the `whatsapp` policy preset, which carries the WebSocket / Noise / h1-ALPN caveats documented in `nemoclaw-blueprint/policies/presets/whatsapp.yaml`. No Meta Business API integration today; that path is out of scope for this matrix. | | ||
| | Microsoft Teams | Experimental | Supported by both OpenClaw and Hermes through the manifest-first messaging channel contract. Requires Bot Framework app credentials, a tenant ID, and a public HTTPS endpoint that reaches the sandbox webhook path `/api/messages`. Sandbox egress goes through the `teams` policy preset, and only one active Teams sandbox can use a given local `MSTEAMS_PORT` forward. | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Split the Teams note across separate lines.
This row packs three sentences onto one source line, which breaks the docs rule that every sentence lives on its own line.
As per path instructions, keep one sentence per line in Markdown and MDX source files.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/reference/platform-support.mdx` at line 120, The Microsoft Teams table
entry in the platform support reference has multiple sentences on one source
line, violating the one-sentence-per-line docs rule. Update the Teams row in the
markdown table so each sentence is placed on its own line while keeping the same
content and structure, and make sure the change is localized to the Teams row in
the platform support section.
Source: Path instructions
<!-- markdownlint-disable MD041 --> ## Summary Refreshes the v0.0.68 docs with release notes, Microsoft Teams messaging guidance, and generated support-matrix coverage. Also corrects the Hermes generated command reference so `sessions export` examples match Hermes-only behavior while keeping the shared command heading compatible with CLI parity checks. ## Changes - NVIDIA#5585 -> `docs/manage-sandboxes/messaging-channels.mdx`, `docs/reference/platform-support.mdx`: Documents experimental Microsoft Teams channel setup, Bot Framework credentials, webhook forwarding, local `MSTEAMS_PORT` conflicts, and the generated integration support row. - NVIDIA#5526 -> `docs/reference/commands.mdx`, `docs/reference/commands-nemohermes.mdx`: Keeps Hermes `sessions export` examples on the supported single-JSONL export path while preserving the canonical shared CLI heading. - NVIDIA#5044 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for installer onboarding failure propagation. - NVIDIA#5641 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for fresh recovery after pre-sandbox installer interruption. - NVIDIA#5673 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for explicit deny-all messaging manifests. - NVIDIA#5743 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for unsupported-agent channel-add rejection. - NVIDIA#5252 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for Hermes `gateway-token` dashboard guidance. - NVIDIA#5659 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for local OpenClaw `agent` wrapper help. - NVIDIA#5661 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for default extra-agent paths. - NVIDIA#5669 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for Deep Agents Code branding. - NVIDIA#5672 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for hosted-compatible default model ID preservation. - NVIDIA#5725 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for Deep Agents Code sandbox liveness. - NVIDIA#5644 -> `docs/about/release-notes.mdx`: Adds v0.0.68 release-note coverage for DGX Spark managed-vLLM express install defaults. - NVIDIA#5712 -> `docs/about/release-notes.mdx`, `docs/reference/platform-support.mdx`: Adds v0.0.68 release-note coverage for the canonical support matrix and updates the matrix source with Teams. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [x] Doc only (includes code sample changes) ## Quality Gates <!-- Check all that apply. For any "covered by existing tests", "not applicable", or waiver entry, add a brief justification on the same line or in the Changes section. --> - [ ] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior — justification: - [x] Tests not applicable — justification: docs-only release refresh; no runtime code changed. - [x] Docs updated for user-facing behavior changes - [ ] Docs not applicable — justification: - [ ] Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging) - [ ] Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: - [ ] Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue: ## Verification <!-- Check each item you ran and confirmed. Leave unchecked items you skipped. Doc-only changes do not require npm test unless you ran it. --> - [x] PR description includes the DCO sign-off declaration and every commit appears as `Verified` in GitHub - [x] Git hooks passed during commit and push, or `npx prek run --from-ref main --to-ref HEAD` passes - [ ] Targeted tests pass for changed behavior - [ ] Full `npm test` passes (broad runtime changes only) - [x] Quality Gates section completed with required justifications or waivers - [x] No secrets, API keys, or credentials committed - [ ] `npm run docs` builds without warnings (doc changes only) — `npm run docs` passed with 0 errors; Fern reported the existing light-mode accent contrast warning. - [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) Additional verification: - `python3 scripts/generate-platform-docs.py --check` passed. - `npm run docs:sync-agent-variants` passed. - `bash test/e2e/e2e-cloud-experimental/check-docs.sh --only-cli` passed. - `npm run docs` passed with 0 errors and one Fern theme warning: light-mode accent contrast ratio is 2.41:1 and should be at least 3:1. - `npm run build:cli` refreshed local untracked `dist/` artifacts after rebase; no tracked files changed. - `npm run typecheck:cli` passed. - Normal commit and push hooks passed after the local CLI rebuild. --- <!-- DCO sign-off is required in this PR description, and every commit must appear as Verified in GitHub. Run: git config user.name && git config user.email --> Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added **Microsoft Teams** as an experimental messaging channel, including manifest-first onboarding, local port routing/conflict handling, sandbox delivery controls, and policy preset support. * **Documentation** * Expanded messaging-channel setup for Teams (prerequisites, credential/webhook setup, wizard flow, and add/remove commands). * Updated reference docs for **agent-specific** session export examples (OpenClaw vs Hermes). * Refreshed platform support guidance and added the latest release-notes entry. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Summary
Refreshes the v0.0.68 docs with release notes, Microsoft Teams messaging guidance, and generated support-matrix coverage.
Also corrects the Hermes generated command reference so
sessions exportexamples match Hermes-only behavior while keeping the shared command heading compatible with CLI parity checks.Changes
docs/manage-sandboxes/messaging-channels.mdx,docs/reference/platform-support.mdx: Documents experimental Microsoft Teams channel setup, Bot Framework credentials, webhook forwarding, localMSTEAMS_PORTconflicts, and the generated integration support row.docs/reference/commands.mdx,docs/reference/commands-nemohermes.mdx: Keeps Hermessessions exportexamples on the supported single-JSONL export path while preserving the canonical shared CLI heading.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for installer onboarding failure propagation.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for fresh recovery after pre-sandbox installer interruption.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for explicit deny-all messaging manifests.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for unsupported-agent channel-add rejection.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for Hermesgateway-tokendashboard guidance.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for local OpenClawagentwrapper help.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for default extra-agent paths.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for Deep Agents Code branding.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for hosted-compatible default model ID preservation.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for Deep Agents Code sandbox liveness.docs/about/release-notes.mdx: Adds v0.0.68 release-note coverage for DGX Spark managed-vLLM express install defaults.docs/about/release-notes.mdx,docs/reference/platform-support.mdx: Adds v0.0.68 release-note coverage for the canonical support matrix and updates the matrix source with Teams.Type of Change
Quality Gates
Verification
Verifiedin GitHubnpx prek run --from-ref main --to-ref HEADpassesnpm testpasses (broad runtime changes only)npm run docsbuilds without warnings (doc changes only) —npm run docspassed with 0 errors; Fern reported the existing light-mode accent contrast warning.Additional verification:
python3 scripts/generate-platform-docs.py --checkpassed.npm run docs:sync-agent-variantspassed.bash test/e2e/e2e-cloud-experimental/check-docs.sh --only-clipassed.npm run docspassed with 0 errors and one Fern theme warning: light-mode accent contrast ratio is 2.41:1 and should be at least 3:1.npm run build:clirefreshed local untrackeddist/artifacts after rebase; no tracked files changed.npm run typecheck:clipassed.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
New Features
Documentation