Skip to content

docs: polish documentation style sweep#4677

Merged
miyoungc merged 1 commit into
mainfrom
docs/edit-sweep
Jun 2, 2026
Merged

docs: polish documentation style sweep#4677
miyoungc merged 1 commit into
mainfrom
docs/edit-sweep

Conversation

@miyoungc
Copy link
Copy Markdown
Collaborator

@miyoungc miyoungc commented Jun 2, 2026

Summary

Polishes NemoClaw documentation prose for style-guide consistency across overview, setup, inference, sandbox management, monitoring, network policy, and security pages.
This PR also includes generated docs sync updates required by the docs validation flow.

Changes

  • Tightened prose, active voice, punctuation, and source-line consistency across existing MDX pages.
  • Preserved existing Fern MDX links while cleaning prose around them.
  • Synced generated docs content for platform/provider and nemohermes command references, and updated the pinned Fern CLI version used by docs validation.

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)

Additional verification:

  • git diff --check passed.
  • npm run docs passed with 0 errors and 1 Fern warning.
  • Commit hooks and pre-push hooks passed.
  • npx prek run --all-files was attempted and failed before commit on existing CLI test assertions in src/lib/adapters/openshell/gateway-drift.test.ts; the doc-specific hook steps passed after generated docs sync.

Signed-off-by: Miyoung Choi miyoungc@nvidia.com

Summary by CodeRabbit

  • Documentation

    • Improved clarity and terminology consistency across deployment, security, and configuration guides.
    • Enhanced troubleshooting steps and prerequisite guidance for various deployment scenarios.
    • Refined onboarding workflow descriptions and security best-practices documentation.
    • Added new command reference entries for in-sandbox operations.
  • Chores

    • Updated Fern configuration version.

@miyoungc miyoungc added the documentation Docs, examples, guides, or messaging need work label Jun 2, 2026
@miyoungc miyoungc self-assigned this Jun 2, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 2, 2026

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This pull request updates documentation across the NemoClaw project, refining terminology, clarifying configuration flows, and restructuring guidance to improve user comprehension. Changes span ecosystem/architecture pages, getting-started guides, deployment instructions, inference setup, sandbox operations, monitoring, network policy, and security best practices. A Fern configuration version bump is also included.

Changes

Documentation Refinement Across All Topics

Layer / File(s) Summary
Ecosystem and architecture documentation
docs/about/ecosystem-hermes.mdx, docs/about/ecosystem.mdx, docs/about/how-it-works.mdx, docs/about/overview.mdx, docs/about/release-notes.mdx
Terminology updated from "DIY OpenShell" to "custom OpenShell"; ecosystem formation and NemoClaw positioning clarified; operator onboarding entry points and Hermes configuration explicitly documented.
Getting started and prerequisites
docs/get-started/prerequisites.mdx, docs/get-started/windows-preparation.mdx, docs/get-started/quickstart.mdx, docs/get-started/quickstart-hermes.mdx, docs/deployment/brev-web-ui.mdx
Docker/Ollama prerequisites and installation requirements explicitly stated; Windows WSL setup troubleshooting refined; third-party software acceptance, installer flows, and dashboard port recovery clarified.
Deployment and hardening guides
docs/deployment/deploy-to-remote-gpu.mdx, docs/deployment/install-openclaw-plugins.mdx, docs/deployment/sandbox-hardening.mdx
Remote dashboard access and CHAT_UI_URL configuration clarified for Brev/port-forward scenarios; sandbox image build timing and readiness budget reworded; proxy configuration and security controls documented more explicitly.
Inference configuration and troubleshooting
docs/inference/inference-options.mdx, docs/inference/set-up-sub-agent.mdx, docs/inference/switch-inference-providers.mdx, docs/inference/tool-calling-reliability.mdx, docs/inference/use-local-inference.mdx
Provider selection and routing clarified; API path troubleshooting and re-probing guidance expanded; Ollama/vLLM/NIM workflows refined; timeout configuration and build-time vs. runtime behavior documented; environment variable behavior at startup vs. image-baked defaults clarified.
Sandbox management and operations
docs/manage-sandboxes/backup-restore.mdx, docs/manage-sandboxes/install-plugins-hermes.mdx, docs/manage-sandboxes/lifecycle.mdx, docs/manage-sandboxes/messaging-channels.mdx, docs/manage-sandboxes/runtime-controls.mdx, docs/manage-sandboxes/workspace-files.mdx
Snapshot contents and versioning clarified; stored-credential reset and upgrade paths expanded; WeChat/WhatsApp experimental channel handling and troubleshooting refined; workspace persistence and multi-agent isolation documented; runtime mutability table and rollback behavior reorganized.
Monitoring and network policy documentation
docs/monitoring/monitor-sandbox-activity.mdx, docs/network-policy/customize-network-policy.mdx, docs/network-policy/integration-policy-examples.mdx
Sandbox health checks and key output fields reformatted; endpoint reachability and policy persistence guidance clarified; preset management and removal procedures reworded.
Reference commands and security documentation
docs/reference/commands-nemohermes.mdx, docs/security/best-practices.mdx, docs/security/credential-storage.mdx, docs/security/openclaw-controls.mdx
New Hermes pass-through command reference sections added (agents, sessions); firewall auto-remediation behavior and NEMOCLAW_AUTO_FIX_FIREWALL documented; security control behavior clarified (locked controls, binary-hash enforcement, symlink handling, best-effort behaviors); credential memory lifecycle and non-readback behavior reinforced.
Configuration version update
fern/fern.config.json
Fern version bumped from 5.41.2 to 5.44.3.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#4632: Updates ecosystem documentation files introduced by this PR to refine terminology consistent with OpenClaw/Hermes variant split.
  • NVIDIA/NemoClaw#4618: Overlaps with best-practices documentation updates regarding lock-workflow and immutability guidance.

Suggested reviewers

  • cv
  • prekshivyas

Poem

🐰 Docs reworded with care and grace,
Clarity blooms in every place,
From ecosystem down to schemas fine,
Each phrase now shines with purpose divine.

🚥 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 PR title 'docs: polish documentation style sweep' is directly related to the main objective of the changeset, which is a documentation prose-polishing effort across multiple doc files for style-guide consistency.
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 docs/edit-sweep

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

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. No E2E is recommended because this PR only changes documentation content and documentation-site configuration. The diff does not touch runtime source code, installer/onboarding logic, credentials, sandbox lifecycle implementation, security or network-policy assets, inference routing code, deployment scripts, or assistant user-flow tests.

Optional E2E

  • None.

New E2E recommendations

  • None.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

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/config-only changes with no modifications under test/e2e-scenario/, scenario workflows, scenario metadata, expected-state contracts, suite definitions, runtime code, or scenario-relevant install/onboarding helpers; scenario E2E is not expected to be affected.

Optional scenario E2E

  • None.

Relevant changed files

  • None.

@miyoungc miyoungc added the v0.0.57 Release target label Jun 2, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

PR Review Advisor

Findings: 0 needs attention, 0 worth checking, 0 nice ideas
Top item: No actionable findings

Workflow run details

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

@miyoungc miyoungc enabled auto-merge (squash) June 2, 2026 20:30
@miyoungc miyoungc merged commit 0c958cf into main Jun 2, 2026
30 of 31 checks passed
@miyoungc miyoungc deleted the docs/edit-sweep branch June 2, 2026 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Docs, examples, guides, or messaging need work v0.0.57 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants