docs: refresh technical documentation style - #5875
Merged
Merged
Conversation
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-5875.docs.buildwithfern.com/nemoclaw |
Contributor
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 |
Contributor
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Contributor
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
|
Contributor
📝 WalkthroughWalkthroughThe PR rewords documentation across about, getting-started, deployment, inference, sandbox operations, network policy, and security pages, and bumps the Fern config version from 5.50.5 to 5.55.0. ChangesDocumentation wording refresh
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related issues
Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Contributor
PR Review Advisor — Changes requestedMerge posture: Do not merge yet Action checklist
Findings index
Review findings by urgency: 0 required fixes, 2 items to resolve/justify, 0 in-scope improvements
|
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Collaborator
Author
|
The PR Review Advisor item about approved network endpoint persistence looks out of scope for this PR. This PR is a broad docs style and wording pass plus the Fern version pin, not a source-of-truth review of network approval lifecycle behavior or a policy lifecycle test change. The requested work needs behavior verification across OpenShell/NemoClaw approval state for stop, restart, rebuild, and destroy/recreate before changing the persistence contract in multiple pages. Related tracking context already exists:
My recommendation is to leave this out of #5875 and handle it through the existing policy/docs follow-up rather than expanding this style-only PR into a behavior/source-of-truth review. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (13)
docs/network-policy/customize-network-policy.mdx (1)
114-114: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winDrop the numbering and colon from this heading.
Line 114 violates the docs title rules twice: section titles should not be numbered, and they should not contain colons.
As per path instructions, "Do not number section titles" and "No colons in titles."🤖 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/network-policy/customize-network-policy.mdx` at line 114, The section heading currently includes both numbering and a colon, which violates the docs title rules. Update the heading text in the markdown section so it no longer starts with “Option 1” and removes the colon, while keeping the meaning the same; make this change on the heading identified by its “Add a Preset File and Use policy-add (Recommended)” text.Source: Path instructions
docs/inference/tool-calling-reliability.mdx (1)
70-70: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueAvoid
:before code examples.Both lead-ins precede code blocks, but this style guide only allows colons when they introduce a list. Reword them to end with periods instead.
Suggested wording
- For a Docker Compose setup, use: + For a Docker Compose setup, use the following.- If you are intentionally testing a mutable OpenClaw config, prepare a batch file like this: + If you are intentionally testing a mutable OpenClaw config, prepare a batch file like the following.As per path instructions, colons should only introduce a list.
Also applies to: 117-117
🤖 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/inference/tool-calling-reliability.mdx` at line 70, The lead-in text before the code examples uses a colon where it should not; update the affected prose in the relevant docs sections (including the text around the Docker Compose example and the other matching lead-in) so the sentence ends with a period instead of introducing the code block with a colon. Locate the wording in the markdown content near the code examples and rephrase it to comply with the style guide while keeping the same meaning.Source: Path instructions
docs/reference/enterprise-readiness.mdx (1)
14-20: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse second person in the intro.
This paragraph addresses the reader indirectly. Rephrase it to speak directly to "you" so it matches the docs style guide. As per path instructions, use active voice, second person, present tense, and direct language in documentation.
🤖 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/enterprise-readiness.mdx` around lines 14 - 20, The intro in the enterprise readiness page is written indirectly and should be rewritten in second person to match the docs style. Update the opening copy to speak directly to “you” while keeping the same meaning, and ensure the wording is active voice, present tense, and direct throughout the intro section.Source: Path instructions
docs/reference/platform-support.mdx (1)
12-16: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse second person in the page intro.
This opener is a bit detached for a docs page. Rephrase it to address the reader directly so it matches the docs style guide. As per path instructions, use active voice, second person, present tense, and direct language in documentation.
🤖 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` around lines 12 - 16, The intro on the platform support page is written in a detached, third-person tone; rewrite the opening copy to address the reader directly in second person while keeping it in present tense and active voice. Update the page intro in the platform support content so it matches the docs style guide and still points readers to the canonical platform matrix generated by scripts/generate-platform-docs.py from ci/platform-matrix.json.Source: Path instructions
docs/get-started/quickstart-langchain-deepagents-code.mdx (1)
61-62: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse second person in this explanation.
"
users may put" breaks the direct-reader voice used elsewhere on the page. Rephrase this as "youmay put ..." to match the docs style guide. As per path instructions, useSecond person ("you") when addressing the reader.🤖 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/get-started/quickstart-langchain-deepagents-code.mdx` around lines 61 - 62, The explanation in the quickstart prose uses third-person language instead of the required direct-reader voice. Update the wording in the affected `langchain-deepagents-code` sandbox description so it speaks to the reader as “you” rather than “users,” keeping the rest of the NemoClaw and `.env`/`.mcp.json` explanation intact and consistent with the page’s second-person style.Source: Path instructions
docs/manage-sandboxes/backup-restore.mdx (1)
94-95: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winKeep this paragraph active.
are intentionally excludedandare also excludedare passive. Rephrase them so the subject performs the action. As per path instructions, active voice is required.🤖 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/backup-restore.mdx` around lines 94 - 95, The backup/restore paragraph uses passive voice in the Hermes snapshot exclusions, so rewrite it in active voice while keeping the same meaning. Update the wording around the mentions of auth.json, config.yaml, and .env so the subject clearly performs the exclusion action, and keep the paragraph active and readable.Source: Path instructions
docs/manage-sandboxes/workspace-files.mdx (1)
142-144: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winKeep the editing guidance active.
can be overwritten by rebuildsis passive. Rephrase it so rebuilds are the subject. As per path instructions, active voice is required.🤖 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/workspace-files.mdx` around lines 142 - 144, The editing guidance in the workspace-files section uses passive voice for the rebuild warning; update the phrasing so rebuilds are the subject, and keep the advice active while preserving the intent. Adjust the sentence about direct edits to `/sandbox/.hermes/config.yaml` and `/sandbox/.hermes/.env` so it clearly states that rebuilds overwrite those files, alongside the existing NemoClaw and openshell guidance.Source: Path instructions
docs/reference/troubleshooting.mdx (2)
158-160: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winKeep the JetPack note active.
are left untouchedis passive. Rephrase the sentence so the installer is the subject. As per path instructions, active voice is required.🤖 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/troubleshooting.mdx` around lines 158 - 160, The JetPack 7 note needs an active-voice rewrite in the troubleshooting text: the current sentence about R39 images uses passive phrasing. Update the affected wording so the installer is the subject (for example, describe that it leaves already-configured `br_netfilter` untouched) while keeping the JetPack 7 / L4T 39.x guidance and the `br_netfilter` / k3s context intact.Source: Path instructions
316-318: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winKeep the Docker 25 note active.
is unaffectedis passive. Rephrase it so the host or Docker configuration is the subject. As per path instructions, active voice is required.🤖 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/troubleshooting.mdx` around lines 316 - 318, The troubleshooting note should keep the Docker 25 guidance active and avoid passive wording in the sentence about unaffected systems. Update the referenced text so the host or Docker configuration is the subject, and keep the distinction clear that this is a Docker default-driver change rather than a NemoClaw or OpenShell regression. Use the existing troubleshooting paragraph in the MDX reference to rephrase the affected sentence in active voice while preserving the Docker 25 and containerd image store details.Source: Path instructions
docs/manage-sandboxes/runtime-controls.mdx (1)
20-21: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAvoid the colon in this lead-in.
This sentence introduces prose, not a list. Split it into two sentences or bullets so it matches the docs style guide. As per path instructions, colons should only introduce a list.
🤖 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/runtime-controls.mdx` around lines 20 - 21, The opening prose in the runtime-controls docs uses a colon to introduce non-list content, which conflicts with the style guide. Update the lead-in around the introductory sentence in the runtime-controls content so it becomes two separate sentences or a short bullet-style setup, and keep the mapping sentence as its own sentence without a colon; use the surrounding prose block in the docs to locate it.Source: Path instructions
docs/reference/commands-nemohermes.mdx (1)
603-603: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueSplit the validation note across separate lines.
This bullet currently compresses three sentences into one source line, which breaks the docs formatting rule.
Suggested split
- OpenClaw sandboxes and registry fallbacks must include at least one target selector flag: `--agent`, `--session-id`, `--session-key`, or `--to` in either `--flag value` or `--flag=value` form. OpenClaw invocations without a selector exit `2` and print `No target session selected` locally, without paying the in-sandbox dispatch cost. Registered terminal-runtime sandboxes delegate bare invocations and help flags to the manifest command instead. + OpenClaw sandboxes and registry fallbacks must include at least one target selector flag: `--agent`, `--session-id`, `--session-key`, or `--to` in either `--flag value` or `--flag=value` form. + OpenClaw invocations without a selector exit `2` and print `No target session selected` locally, without paying the in-sandbox dispatch cost. + Registered terminal-runtime sandboxes delegate bare invocations and help flags to the manifest command instead.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/commands-nemohermes.mdx` at line 603, The validation note in the MDX docs is written as multiple sentences on one source line, which violates the one-sentence-per-line rule. Update the affected bullet in the documentation content so each sentence is placed on its own line while keeping the same wording and meaning; use the surrounding note section in the docs file as the location reference.Source: Path instructions
docs/manage-sandboxes/messaging-channels.mdx (1)
63-64: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueSplit these table cells into one sentence each.
docs/**files should keep one sentence per line, but these rows put theNo required tokensnote and the description on the same source line.<s
Suggested split
-| WeChat (experimental) | None. Captured through host-side QR scan during `$$nemoclaw onboard` | `WECHAT_ALLOWED_IDS` for DM allowlisting | -| WhatsApp (experimental) | None. Pair through QR after rebuild | None | +| WeChat (experimental) | No required tokens; captured through host-side QR scan during `$$nemoclaw onboard` | `WECHAT_ALLOWED_IDS` for DM allowlisting | +| WhatsApp (experimental) | No required tokens; pair through QR after rebuild | None |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/manage-sandboxes/messaging-channels.mdx` around lines 63 - 64, The messaging channels table rows currently combine two sentences in single source lines, which violates the docs/source convention. Update the table entries in messaging-channels.mdx so each sentence is split onto its own source line while keeping the same content and meaning, using the affected table rows for WeChat and WhatsApp as the target locations.Source: Path instructions
docs/reference/commands.mdx (1)
603-603: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueSplit the validation note across separate lines.
This bullet currently compresses three sentences into one source line, which breaks the docs formatting rule.
Suggested split
- OpenClaw sandboxes and registry fallbacks must include at least one target selector flag: `--agent`, `--session-id`, `--session-key`, or `--to` in either `--flag value` or `--flag=value` form. OpenClaw invocations without a selector exit `2` and print `No target session selected` locally, without paying the in-sandbox dispatch cost. Registered terminal-runtime sandboxes delegate bare invocations and help flags to the manifest command instead. + OpenClaw sandboxes and registry fallbacks must include at least one target selector flag: `--agent`, `--session-id`, `--session-key`, or `--to` in either `--flag value` or `--flag=value` form. + OpenClaw invocations without a selector exit `2` and print `No target session selected` locally, without paying the in-sandbox dispatch cost. + Registered terminal-runtime sandboxes delegate bare invocations and help flags to the manifest command instead.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/commands.mdx` at line 603, The validation note in the commands reference needs to be split so each sentence is on its own line to satisfy the MDX formatting rule. Update the bullet containing the OpenClaw selector guidance in the commands documentation so the three sentences are separated by line breaks while keeping the same wording and meaning.Source: Path instructions
🤖 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/get-started/prerequisites.mdx`:
- Line 91: The Next Steps link in the prerequisites content points to the wrong
route, causing a broken cross-reference. Update the link in the prerequisites
page to target the sibling Windows preparation doc rather than a child route,
using the existing Windows preparation reference in the get-started docs so the
destination resolves correctly.
In `@docs/security/openclaw-controls.mdx`:
- Line 104: The DM policy mode values in the OpenClaw controls table are plain
text but should be inline code-formatted literal options. Update the row in the
documentation so the mode names in the sentence within the table use inline code
styling for open, disabled, pairing, and allowlist, following the existing docs
convention for literal values.
- Line 38: The prose in openclaw-controls.mdx uses the wrong casing for gateway
in the OpenClaw deny list description. Update the sentence in the table row that
mentions Gateway HTTP so it uses lowercase gateway unless it begins the
sentence, keeping the rest of the wording unchanged.
---
Nitpick comments:
In `@docs/get-started/quickstart-langchain-deepagents-code.mdx`:
- Around line 61-62: The explanation in the quickstart prose uses third-person
language instead of the required direct-reader voice. Update the wording in the
affected `langchain-deepagents-code` sandbox description so it speaks to the
reader as “you” rather than “users,” keeping the rest of the NemoClaw and
`.env`/`.mcp.json` explanation intact and consistent with the page’s
second-person style.
In `@docs/inference/tool-calling-reliability.mdx`:
- Line 70: The lead-in text before the code examples uses a colon where it
should not; update the affected prose in the relevant docs sections (including
the text around the Docker Compose example and the other matching lead-in) so
the sentence ends with a period instead of introducing the code block with a
colon. Locate the wording in the markdown content near the code examples and
rephrase it to comply with the style guide while keeping the same meaning.
In `@docs/manage-sandboxes/backup-restore.mdx`:
- Around line 94-95: The backup/restore paragraph uses passive voice in the
Hermes snapshot exclusions, so rewrite it in active voice while keeping the same
meaning. Update the wording around the mentions of auth.json, config.yaml, and
.env so the subject clearly performs the exclusion action, and keep the
paragraph active and readable.
In `@docs/manage-sandboxes/messaging-channels.mdx`:
- Around line 63-64: The messaging channels table rows currently combine two
sentences in single source lines, which violates the docs/source convention.
Update the table entries in messaging-channels.mdx so each sentence is split
onto its own source line while keeping the same content and meaning, using the
affected table rows for WeChat and WhatsApp as the target locations.
In `@docs/manage-sandboxes/runtime-controls.mdx`:
- Around line 20-21: The opening prose in the runtime-controls docs uses a colon
to introduce non-list content, which conflicts with the style guide. Update the
lead-in around the introductory sentence in the runtime-controls content so it
becomes two separate sentences or a short bullet-style setup, and keep the
mapping sentence as its own sentence without a colon; use the surrounding prose
block in the docs to locate it.
In `@docs/manage-sandboxes/workspace-files.mdx`:
- Around line 142-144: The editing guidance in the workspace-files section uses
passive voice for the rebuild warning; update the phrasing so rebuilds are the
subject, and keep the advice active while preserving the intent. Adjust the
sentence about direct edits to `/sandbox/.hermes/config.yaml` and
`/sandbox/.hermes/.env` so it clearly states that rebuilds overwrite those
files, alongside the existing NemoClaw and openshell guidance.
In `@docs/network-policy/customize-network-policy.mdx`:
- Line 114: The section heading currently includes both numbering and a colon,
which violates the docs title rules. Update the heading text in the markdown
section so it no longer starts with “Option 1” and removes the colon, while
keeping the meaning the same; make this change on the heading identified by its
“Add a Preset File and Use policy-add (Recommended)” text.
In `@docs/reference/commands-nemohermes.mdx`:
- Line 603: The validation note in the MDX docs is written as multiple sentences
on one source line, which violates the one-sentence-per-line rule. Update the
affected bullet in the documentation content so each sentence is placed on its
own line while keeping the same wording and meaning; use the surrounding note
section in the docs file as the location reference.
In `@docs/reference/commands.mdx`:
- Line 603: The validation note in the commands reference needs to be split so
each sentence is on its own line to satisfy the MDX formatting rule. Update the
bullet containing the OpenClaw selector guidance in the commands documentation
so the three sentences are separated by line breaks while keeping the same
wording and meaning.
In `@docs/reference/enterprise-readiness.mdx`:
- Around line 14-20: The intro in the enterprise readiness page is written
indirectly and should be rewritten in second person to match the docs style.
Update the opening copy to speak directly to “you” while keeping the same
meaning, and ensure the wording is active voice, present tense, and direct
throughout the intro section.
In `@docs/reference/platform-support.mdx`:
- Around line 12-16: The intro on the platform support page is written in a
detached, third-person tone; rewrite the opening copy to address the reader
directly in second person while keeping it in present tense and active voice.
Update the page intro in the platform support content so it matches the docs
style guide and still points readers to the canonical platform matrix generated
by scripts/generate-platform-docs.py from ci/platform-matrix.json.
In `@docs/reference/troubleshooting.mdx`:
- Around line 158-160: The JetPack 7 note needs an active-voice rewrite in the
troubleshooting text: the current sentence about R39 images uses passive
phrasing. Update the affected wording so the installer is the subject (for
example, describe that it leaves already-configured `br_netfilter` untouched)
while keeping the JetPack 7 / L4T 39.x guidance and the `br_netfilter` / k3s
context intact.
- Around line 316-318: The troubleshooting note should keep the Docker 25
guidance active and avoid passive wording in the sentence about unaffected
systems. Update the referenced text so the host or Docker configuration is the
subject, and keep the distinction clear that this is a Docker default-driver
change rather than a NemoClaw or OpenShell regression. Use the existing
troubleshooting paragraph in the MDX reference to rephrase the affected sentence
in active voice while preserving the Docker 25 and containerd image store
details.
🪄 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: d0efcdd0-de43-4db3-9dcd-cc86345753f5
📒 Files selected for processing (44)
docs/CONTRIBUTING.mddocs/about/ecosystem-hermes.mdxdocs/about/ecosystem.mdxdocs/about/how-it-works.mdxdocs/about/overview.mdxdocs/about/release-notes.mdxdocs/deployment/brev-web-ui.mdxdocs/deployment/deploy-to-remote-gpu.mdxdocs/deployment/install-openclaw-plugins.mdxdocs/deployment/sandbox-hardening.mdxdocs/get-started/prerequisites.mdxdocs/get-started/quickstart-hermes.mdxdocs/get-started/quickstart-langchain-deepagents-code.mdxdocs/get-started/quickstart.mdxdocs/get-started/windows-preparation.mdxdocs/inference/declarative-agents-manifest.mdxdocs/inference/inference-options.mdxdocs/inference/set-up-sub-agent.mdxdocs/inference/switch-inference-providers.mdxdocs/inference/tool-calling-reliability.mdxdocs/inference/use-local-inference.mdxdocs/manage-sandboxes/backup-restore.mdxdocs/manage-sandboxes/install-plugins-hermes.mdxdocs/manage-sandboxes/lifecycle.mdxdocs/manage-sandboxes/messaging-channels.mdxdocs/manage-sandboxes/runtime-controls.mdxdocs/manage-sandboxes/workspace-files.mdxdocs/monitoring/monitor-sandbox-activity.mdxdocs/network-policy/approve-network-requests.mdxdocs/network-policy/customize-network-policy.mdxdocs/network-policy/integration-policy-examples.mdxdocs/reference/architecture.mdxdocs/reference/cli-selection-guide.mdxdocs/reference/commands-nemohermes.mdxdocs/reference/commands.mdxdocs/reference/enterprise-readiness.mdxdocs/reference/network-policies.mdxdocs/reference/platform-support.mdxdocs/reference/troubleshooting.mdxdocs/resources/agent-skills.mdxdocs/security/best-practices.mdxdocs/security/credential-storage.mdxdocs/security/openclaw-controls.mdxfern/fern.config.json
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/reference/commands.mdx (1)
2056-2056: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winKeep this sentence on a single source line.
This edit wraps one sentence across two lines, which breaks the MDX source formatting rule for sentence-per-line docs. As per coding guidelines, "Keep one sentence per line in Markdown and MDX source files," and as per path instructions, "One sentence per line in source (makes diffs readable)."
🤖 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/commands.mdx` at line 2056, The sentence in the MDX guidance text is split across multiple source lines, which violates the sentence-per-line formatting rule. Update the affected sentence in the documentation so the entire sentence stays on a single source line, keeping the surrounding MDX content unchanged; use the nearby guidance text in commands.mdx to locate and reflow only this sentence.Sources: Coding guidelines, Path instructions
docs/reference/commands-nemohermes.mdx (1)
1701-1701: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winKeep this sentence on a single source line.
This edit wraps one sentence across two lines, which breaks the MDX source formatting rule for sentence-per-line docs. As per coding guidelines, "Keep one sentence per line in Markdown and MDX source files," and as per path instructions, "One sentence per line in source (makes diffs readable)."
🤖 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/commands-nemohermes.mdx` at line 1701, The sentence in the referenced MDX source is split across two lines, violating the one-sentence-per-line formatting rule. Update the surrounding content in the command docs so the full sentence stays on a single source line, and keep an eye on the affected sentence in the docs reference content to preserve sentence-per-line formatting.Sources: Coding guidelines, Path instructions
🤖 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.
Nitpick comments:
In `@docs/reference/commands-nemohermes.mdx`:
- Line 1701: The sentence in the referenced MDX source is split across two
lines, violating the one-sentence-per-line formatting rule. Update the
surrounding content in the command docs so the full sentence stays on a single
source line, and keep an eye on the affected sentence in the docs reference
content to preserve sentence-per-line formatting.
In `@docs/reference/commands.mdx`:
- Line 2056: The sentence in the MDX guidance text is split across multiple
source lines, which violates the sentence-per-line formatting rule. Update the
affected sentence in the documentation so the entire sentence stays on a single
source line, keeping the surrounding MDX content unchanged; use the nearby
guidance text in commands.mdx to locate and reflow only this sentence.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: ca90e21c-aebe-4351-98c9-643dcf66fa7d
📒 Files selected for processing (30)
docs/about/ecosystem.mdxdocs/about/how-it-works.mdxdocs/about/overview.mdxdocs/about/release-notes.mdxdocs/deployment/brev-web-ui.mdxdocs/deployment/install-openclaw-plugins.mdxdocs/get-started/prerequisites.mdxdocs/get-started/windows-preparation.mdxdocs/inference/declarative-agents-manifest.mdxdocs/inference/inference-options.mdxdocs/inference/use-local-inference.mdxdocs/manage-sandboxes/backup-restore.mdxdocs/manage-sandboxes/install-plugins-hermes.mdxdocs/manage-sandboxes/lifecycle.mdxdocs/manage-sandboxes/messaging-channels.mdxdocs/manage-sandboxes/runtime-controls.mdxdocs/manage-sandboxes/workspace-files.mdxdocs/monitoring/monitor-sandbox-activity.mdxdocs/network-policy/customize-network-policy.mdxdocs/network-policy/integration-policy-examples.mdxdocs/reference/architecture.mdxdocs/reference/commands-nemohermes.mdxdocs/reference/commands.mdxdocs/reference/enterprise-readiness.mdxdocs/reference/network-policies.mdxdocs/reference/platform-support.mdxdocs/reference/troubleshooting.mdxdocs/resources/license.mdxdocs/security/best-practices.mdxdocs/security/credential-storage.mdx
✅ Files skipped from review due to trivial changes (23)
- docs/resources/license.mdx
- docs/about/release-notes.mdx
- docs/manage-sandboxes/runtime-controls.mdx
- docs/get-started/prerequisites.mdx
- docs/reference/architecture.mdx
- docs/reference/network-policies.mdx
- docs/deployment/brev-web-ui.mdx
- docs/manage-sandboxes/workspace-files.mdx
- docs/about/overview.mdx
- docs/manage-sandboxes/install-plugins-hermes.mdx
- docs/inference/use-local-inference.mdx
- docs/deployment/install-openclaw-plugins.mdx
- docs/reference/platform-support.mdx
- docs/get-started/windows-preparation.mdx
- docs/inference/declarative-agents-manifest.mdx
- docs/security/credential-storage.mdx
- docs/about/how-it-works.mdx
- docs/reference/troubleshooting.mdx
- docs/inference/inference-options.mdx
- docs/network-policy/customize-network-policy.mdx
- docs/manage-sandboxes/lifecycle.mdx
- docs/about/ecosystem.mdx
- docs/monitoring/monitor-sandbox-activity.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/manage-sandboxes/backup-restore.mdx
- docs/network-policy/integration-policy-examples.mdx
- docs/security/best-practices.mdx
cv
approved these changes
Jun 26, 2026
Hadar301
pushed a commit
to Hadar301/NemoClaw-OpenShift
that referenced
this pull request
Jul 12, 2026
<!-- markdownlint-disable MD041 --> ## Summary Runs a broad technical edit pass across the published NemoClaw docs to tighten wording, active voice, sentence structure, and style-guide consistency. Includes the Fern CLI pin upgrade from `5.50.5` to `5.55.0`. ## Changes - Edited existing `docs/` pages across the user guide for clearer, more direct technical prose. - Applied the requested wording convention for list and table introductions that use `the following`. - Preserved existing code samples while updating surrounding prose and style-guide wording. - Updated `fern/fern.config.json` to use Fern `5.55.0`. ## 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) ## 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: documentation-only wording edits plus Fern CLI version pin. - [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) - [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) Verification notes: - `npm run docs` passed with 0 errors and 1 Fern theme contrast warning. - `cd fern && npx --yes fern-api@5.55.0 check --warnings` reported the same light-mode accent color contrast warning. - `npm run build:cli` passed before the final push so the pre-push TypeScript hook could validate against fresh `dist/` output. --- <!-- 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 * **Documentation** * Reworded and clarified user guides across setup, deployment, inference, sandbox management, networking, security, and CLI/reference docs. * Improved quickstarts, prerequisites, troubleshooting, and environment-variable/command behavior explanations (including sandbox hardening, credential handling, runtime controls, and network policy workflows). * Expanded operational guidance and cross-references, with clearer phrasing for Hermes/OpenClaw differences and runtime expectations. * **Chores** * Updated documentation tooling/configuration version. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Runs a broad technical edit pass across the published NemoClaw docs to tighten wording, active voice, sentence structure, and style-guide consistency.
Includes the Fern CLI pin upgrade from
5.50.5to5.55.0.Changes
docs/pages across the user guide for clearer, more direct technical prose.the following.fern/fern.config.jsonto use Fern5.55.0.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)Verification notes:
npm run docspassed with 0 errors and 1 Fern theme contrast warning.cd fern && npx --yes fern-api@5.55.0 check --warningsreported the same light-mode accent color contrast warning.npm run build:clipassed before the final push so the pre-push TypeScript hook could validate against freshdist/output.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit