docs: polish documentation style sweep#4677
Conversation
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughThis 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. ChangesDocumentation Refinement Across All Topics
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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-4677.docs.buildwithfern.com/nemoclaw |
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
E2E Scenario Advisor RecommendationRequired scenario E2E: None Full scenario advisor summaryE2E Scenario AdvisorBase: Required scenario E2E
Optional scenario E2E
Relevant changed files
|
PR Review AdvisorFindings: 0 needs attention, 0 worth checking, 0 nice ideas This is an automated advisory review. A human maintainer must make the final merge decision. |
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
nemohermescommand references, and updated the pinned Fern CLI version used by docs validation.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Additional verification:
git diff --checkpassed.npm run docspassed with 0 errors and 1 Fern warning.npx prek run --all-fileswas attempted and failed before commit on existing CLI test assertions insrc/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
Chores