docs: split description into main/agent and clean up docs-to-skills#1389
Merged
docs: split description into main/agent and clean up docs-to-skills#1389
Conversation
- Add Gateway Authentication Controls section to security best practices covering device auth, insecure auth derivation, auto-pair allowlist, and CLI secret redaction (from commits 2804b74, cb668d7) - Add device auth mistake to Common Mistakes table - Update legacy `nemoclaw setup` to reflect delegation to onboard (7c3687e) - Fix docs-to-skills command in CLAUDE.md (correct output path, python3) - Regenerate agent skills Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
📝 WalkthroughWalkthroughThe PR restructures documentation metadata by transforming the Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
miyoungc
changed the title
![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: 9
🧹 Nitpick comments (7)
docs/security/best-practices.md (1)
7-7: Splitdescription.agentinto one sentence per line.Line 7 has two sentences in a single line; please split to conform to docs formatting expectations.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/security/best-practices.md` at line 7, The line for description.agent contains two sentences on a single line; split that string so each sentence is on its own line (one sentence per line) to match the docs formatting rule. Locate the description.agent entry and break the text into separate lines at the sentence boundary, preserving punctuation and spacing, and ensure no other sentences remain combined on a single line in that same block.docs/network-policy/approve-network-requests.md (1)
7-7: Formatdescription.agentas one sentence per line.Line 7 has two sentences on one line; split them to keep docs diffs readable and consistent.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/network-policy/approve-network-requests.md` at line 7, The description.agent string contains two sentences on one line; split it into two separate lines so each sentence is its own line (e.g., "Reviews and approves blocked agent network requests in the TUI." on one line and "Use when approving or denying sandbox egress requests, managing blocked network calls, or using the approval TUI." on the next) to comply with the one-sentence-per-line guideline and keep diffs readable; update the description.agent entry accordingly.docs/about/how-it-works.md (1)
7-7: Use one sentence per line indescription.agent.Line 7 contains two sentences on a single source line; split them to follow docs formatting conventions.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/about/how-it-works.md` at line 7, The description.agent value currently contains two sentences on a single line; update description.agent so each sentence is on its own source line (split the existing string into two lines, one sentence per line) to comply with the "one sentence per line" docs convention; locate the description.agent entry in the same block containing the agent string and break it into two separate lines preserving the text and punctuation.docs/reference/architecture.md (1)
7-7: Splitdescription.agentinto one sentence per source line.Line 7 places two sentences on one line; keep one sentence per line to match docs-source formatting rules.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/architecture.md` at line 7, The field description.agent contains two sentences on a single source line; split it so each sentence is on its own line to follow "one sentence per line" docs formatting. Edit the description.agent value and break the combined string into two separate lines (one sentence per line) preserving punctuation and indentation so the parsed content and formatting rules remain correct.docs/reference/troubleshooting.md (1)
7-7: Splitdescription.agentinto separate source lines per sentence.Line 7 combines two sentences on a single line; update it to one sentence per line.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/troubleshooting.md` at line 7, Update the docs so the YAML/metadata field description.agent is split into separate source lines with one sentence per line; locate the entry that currently reads the two-sentence value for agent (the string starting "Diagnoses and resolves...") and break it into two lines each containing one sentence, preserving the same wording and quoting/indentation for the description.agent field.docs/inference/switch-inference-providers.md (1)
7-7: Keepdescription.agentto one sentence per source line.Line 7 combines two sentences on one line; split them to match documentation formatting rules.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/inference/switch-inference-providers.md` at line 7, The documentation string for description.agent currently contains multiple sentences on a single source line; edit the markdown so each sentence is on its own source line (split the existing line into two lines) so description.agent has one sentence per line, preserving wording and punctuation and keeping each sentence as a separate line for proper diffs.docs/reference/network-policies.md (1)
7-7: Apply one-sentence-per-line formatting indescription.agent.Line 7 currently has two sentences on one line; split for consistency with docs style.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/network-policies.md` at line 7, The description.agent string currently contains two sentences on the same line; split it so each sentence is on its own line to follow one-sentence-per-line docs style—locate description.agent in the docs/reference/network-policies.md entry and break the text into two lines (first sentence on line one, second sentence on line two) preserving punctuation and spacing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/about/overview.md`:
- Around line 5-7: The 'agent' description value in the frontmatter contains two
sentences on one line; update the description.agent block so each sentence is on
its own YAML line (split the existing string into two lines under the agent
key), preserving the wording and quotes and ensuring valid YAML formatting for
the description mapping.
In `@docs/deployment/deploy-to-remote-gpu.md`:
- Around line 5-7: The agent description string in the YAML (description.agent)
contains two sentences on one line; split them so each sentence is on its own
line within the YAML value (e.g., break the current "Provisions a remote GPU VM
with NemoClaw using Brev deployment. Use when deploying to a cloud GPU, setting
up a remote NemoClaw instance, or configuring Brev." into two separate lines
while preserving the same wording and indentation).
In `@docs/deployment/sandbox-hardening.md`:
- Around line 5-7: The YAML "agent" description currently has two sentences on a
single line under the description -> agent key; split them so each sentence
occupies its own line (e.g., break the agent string into two lines or convert to
a block scalar) so every sentence is on a separate line in the agent description
value.
In `@docs/get-started/quickstart.md`:
- Around line 5-7: The agent description under the YAML key "description.agent"
currently has two sentences on one line; split them so each sentence is on its
own line (one sentence per line) to follow the "one sentence per line"
guideline—edit the value for description.agent so the first sentence "Installs
NemoClaw, launches a sandbox, and runs the first agent prompt." is on its own
line and the second sentence "Use when onboarding, installing, or launching a
NemoClaw sandbox for the first time." is on the following line.
In `@docs/monitoring/monitor-sandbox-activity.md`:
- Around line 5-7: The agent description string in the YAML frontmatter (key
"description.agent") contains two sentences on one line; split them so each
sentence is on its own line. Edit the "agent" value so the first sentence ends
on its own line and the second sentence begins on the next line, preserving text
and punctuation and keeping the "description" and "agent" keys unchanged.
In `@docs/reference/commands.md`:
- Around line 5-7: The agent description under the YAML key "description.agent"
currently has two sentences on one line; split them into two separate lines so
each sentence is its own line (preserving YAML indentation and quotes) — locate
the "description.agent" entry and break the text into one sentence per line
while keeping the same content and quoting style.
In `@docs/reference/inference-profiles.md`:
- Around line 5-7: The agent description string under the YAML key
description.agent contains two sentences on the same line; split them so each
sentence is on its own line (i.e., break the value of description.agent into two
separate lines with the first sentence on one line and the second sentence on
the next) while preserving the existing wording and YAML indentation.
In `@docs/resources/license.md`:
- Around line 5-7: The agent description under the YAML key description.agent
contains two sentences on the same line; split them so each sentence is on its
own line (i.e., break the agent value into two lines, one sentence per line) to
follow the "one sentence per line" guideline and keep the key name
description.agent intact.
In `@docs/workspace/workspace-files.md`:
- Line 7: The agent description string uses plain text filenames; update the
`agent` description to use inline code formatting and the canonical uppercase
filenames (e.g., `SOUL.md`, `IDENTITY.md`, `MEMORY.md`, `AGENTS.md`) so CLI/file
references follow the doc guidelines; locate the `agent` field in this document
and replace occurrences like "soul.md", "identity.md", "memory.md", "agents.md"
with backticked `SOUL.md`, `IDENTITY.md`, `MEMORY.md`, `AGENTS.md`.
---
Nitpick comments:
In `@docs/about/how-it-works.md`:
- Line 7: The description.agent value currently contains two sentences on a
single line; update description.agent so each sentence is on its own source line
(split the existing string into two lines, one sentence per line) to comply with
the "one sentence per line" docs convention; locate the description.agent entry
in the same block containing the agent string and break it into two separate
lines preserving the text and punctuation.
In `@docs/inference/switch-inference-providers.md`:
- Line 7: The documentation string for description.agent currently contains
multiple sentences on a single source line; edit the markdown so each sentence
is on its own source line (split the existing line into two lines) so
description.agent has one sentence per line, preserving wording and punctuation
and keeping each sentence as a separate line for proper diffs.
In `@docs/network-policy/approve-network-requests.md`:
- Line 7: The description.agent string contains two sentences on one line; split
it into two separate lines so each sentence is its own line (e.g., "Reviews and
approves blocked agent network requests in the TUI." on one line and "Use when
approving or denying sandbox egress requests, managing blocked network calls, or
using the approval TUI." on the next) to comply with the one-sentence-per-line
guideline and keep diffs readable; update the description.agent entry
accordingly.
In `@docs/reference/architecture.md`:
- Line 7: The field description.agent contains two sentences on a single source
line; split it so each sentence is on its own line to follow "one sentence per
line" docs formatting. Edit the description.agent value and break the combined
string into two separate lines (one sentence per line) preserving punctuation
and indentation so the parsed content and formatting rules remain correct.
In `@docs/reference/network-policies.md`:
- Line 7: The description.agent string currently contains two sentences on the
same line; split it so each sentence is on its own line to follow
one-sentence-per-line docs style—locate description.agent in the
docs/reference/network-policies.md entry and break the text into two lines
(first sentence on line one, second sentence on line two) preserving punctuation
and spacing.
In `@docs/reference/troubleshooting.md`:
- Line 7: Update the docs so the YAML/metadata field description.agent is split
into separate source lines with one sentence per line; locate the entry that
currently reads the two-sentence value for agent (the string starting "Diagnoses
and resolves...") and break it into two lines each containing one sentence,
preserving the same wording and quoting/indentation for the description.agent
field.
In `@docs/security/best-practices.md`:
- Line 7: The line for description.agent contains two sentences on a single
line; split that string so each sentence is on its own line (one sentence per
line) to match the docs formatting rule. Locate the description.agent entry and
break the text into separate lines at the sentence boundary, preserving
punctuation and spacing, and ensure no other sentences remain combined on a
single line in that same block.
🪄 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: Pro
Run ID: d6223885-1918-439d-8bb4-27c734095328
📒 Files selected for processing (35)
.agents/skills/nemoclaw-configure-inference/SKILL.md.agents/skills/nemoclaw-deploy-remote/SKILL.md.agents/skills/nemoclaw-get-started/SKILL.md.agents/skills/nemoclaw-manage-policy/SKILL.md.agents/skills/nemoclaw-monitor-sandbox/SKILL.md.agents/skills/nemoclaw-overview/SKILL.md.agents/skills/nemoclaw-reference/SKILL.md.agents/skills/nemoclaw-security-best/SKILL.md.agents/skills/nemoclaw-workspace/SKILL.mddocs/CONTRIBUTING.mddocs/_ext/json_output/core/json_formatter.pydocs/_ext/search_assets/modules/DocumentLoader.jsdocs/_ext/search_assets/modules/SearchEngine.jsdocs/about/how-it-works.mddocs/about/overview.mddocs/about/release-notes.mddocs/deployment/deploy-to-remote-gpu.mddocs/deployment/sandbox-hardening.mddocs/deployment/set-up-telegram-bridge.mddocs/get-started/quickstart.mddocs/index.mddocs/inference/switch-inference-providers.mddocs/monitoring/monitor-sandbox-activity.mddocs/network-policy/approve-network-requests.mddocs/network-policy/customize-network-policy.mddocs/reference/architecture.mddocs/reference/commands.mddocs/reference/inference-profiles.mddocs/reference/network-policies.mddocs/reference/troubleshooting.mddocs/resources/license.mddocs/security/best-practices.mddocs/workspace/backup-restore.mddocs/workspace/workspace-files.mdscripts/docs-to-skills.py
Comment on lines
+5
to
+7
| description: | ||
| main: "NemoClaw is an open source reference stack that simplifies running OpenClaw always-on assistants safely." | ||
| agent: "Explains what NemoClaw does and how it fits with OpenClaw and OpenShell. Use when asking what NemoClaw is, how it works at a high level, or what the project provides." |
Contributor
There was a problem hiding this comment.
Split sentences to one per line in the agent description.
Line 7 contains two sentences on the same line. As per coding guidelines, each sentence must appear on its own line in the source for readable diffs.
📝 Proposed fix
description:
main: "NemoClaw is an open source reference stack that simplifies running OpenClaw always-on assistants safely."
- agent: "Explains what NemoClaw does and how it fits with OpenClaw and OpenShell. Use when asking what NemoClaw is, how it works at a high level, or what the project provides."
+ agent: >-
+ Explains what NemoClaw does and how it fits with OpenClaw and OpenShell.
+ Use when asking what NemoClaw is, how it works at a high level, or what the project provides.📝 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.
Suggested change
| description: | |
| main: "NemoClaw is an open source reference stack that simplifies running OpenClaw always-on assistants safely." | |
| agent: "Explains what NemoClaw does and how it fits with OpenClaw and OpenShell. Use when asking what NemoClaw is, how it works at a high level, or what the project provides." | |
| description: | |
| main: "NemoClaw is an open source reference stack that simplifies running OpenClaw always-on assistants safely." | |
| agent: >- | |
| Explains what NemoClaw does and how it fits with OpenClaw and OpenShell. | |
| Use when asking what NemoClaw is, how it works at a high level, or what the project provides. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/about/overview.md` around lines 5 - 7, The 'agent' description value in
the frontmatter contains two sentences on one line; update the description.agent
block so each sentence is on its own YAML line (split the existing string into
two lines under the agent key), preserving the wording and quotes and ensuring
valid YAML formatting for the description mapping.
Comment on lines
+5
to
+7
| description: | ||
| main: "Provision a remote GPU VM with NemoClaw using Brev deployment." | ||
| agent: "Provisions a remote GPU VM with NemoClaw using Brev deployment. Use when deploying to a cloud GPU, setting up a remote NemoClaw instance, or configuring Brev." |
Contributor
There was a problem hiding this comment.
Split sentences to one per line in the agent description.
Line 7 contains two sentences on the same line, violating the one-sentence-per-line formatting requirement. As per coding guidelines, each sentence must appear on its own line.
📝 Proposed fix
description:
main: "Provision a remote GPU VM with NemoClaw using Brev deployment."
- agent: "Provisions a remote GPU VM with NemoClaw using Brev deployment. Use when deploying to a cloud GPU, setting up a remote NemoClaw instance, or configuring Brev."
+ agent: >-
+ Provisions a remote GPU VM with NemoClaw using Brev deployment.
+ Use when deploying to a cloud GPU, setting up a remote NemoClaw instance, or configuring Brev.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/deployment/deploy-to-remote-gpu.md` around lines 5 - 7, The agent
description string in the YAML (description.agent) contains two sentences on one
line; split them so each sentence is on its own line within the YAML value
(e.g., break the current "Provisions a remote GPU VM with NemoClaw using Brev
deployment. Use when deploying to a cloud GPU, setting up a remote NemoClaw
instance, or configuring Brev." into two separate lines while preserving the
same wording and indentation).
Comment on lines
+5
to
+7
| description: | ||
| main: "Security hardening measures applied to the NemoClaw sandbox container image." | ||
| agent: "Describes security hardening measures applied to the NemoClaw sandbox container image. Use when reviewing container security, Docker capabilities, process limits, or sandbox hardening controls." |
Contributor
There was a problem hiding this comment.
Split sentences to one per line in the agent description.
Line 7 contains two sentences on the same line. As per coding guidelines, one sentence per line is required in source to make diffs readable.
📝 Proposed fix
description:
main: "Security hardening measures applied to the NemoClaw sandbox container image."
- agent: "Describes security hardening measures applied to the NemoClaw sandbox container image. Use when reviewing container security, Docker capabilities, process limits, or sandbox hardening controls."
+ agent: >-
+ Describes security hardening measures applied to the NemoClaw sandbox container image.
+ Use when reviewing container security, Docker capabilities, process limits, or sandbox hardening controls.📝 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.
Suggested change
| description: | |
| main: "Security hardening measures applied to the NemoClaw sandbox container image." | |
| agent: "Describes security hardening measures applied to the NemoClaw sandbox container image. Use when reviewing container security, Docker capabilities, process limits, or sandbox hardening controls." | |
| description: | |
| main: "Security hardening measures applied to the NemoClaw sandbox container image." | |
| agent: >- | |
| Describes security hardening measures applied to the NemoClaw sandbox container image. | |
| Use when reviewing container security, Docker capabilities, process limits, or sandbox hardening controls. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/deployment/sandbox-hardening.md` around lines 5 - 7, The YAML "agent"
description currently has two sentences on a single line under the description
-> agent key; split them so each sentence occupies its own line (e.g., break the
agent string into two lines or convert to a block scalar) so every sentence is
on a separate line in the agent description value.
Comment on lines
+5
to
+7
| description: | ||
| main: "Install NemoClaw, launch a sandbox, and run your first agent prompt." | ||
| agent: "Installs NemoClaw, launches a sandbox, and runs the first agent prompt. Use when onboarding, installing, or launching a NemoClaw sandbox for the first time." |
Contributor
There was a problem hiding this comment.
Split sentences to one per line in the agent description.
Line 7 contains two sentences on the same line, which violates the formatting guideline requiring one sentence per line for readable diffs. As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
📝 Proposed fix
description:
main: "Install NemoClaw, launch a sandbox, and run your first agent prompt."
- agent: "Installs NemoClaw, launches a sandbox, and runs the first agent prompt. Use when onboarding, installing, or launching a NemoClaw sandbox for the first time."
+ agent: >-
+ Installs NemoClaw, launches a sandbox, and runs the first agent prompt.
+ Use when onboarding, installing, or launching a NemoClaw sandbox for the first time.📝 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.
Suggested change
| description: | |
| main: "Install NemoClaw, launch a sandbox, and run your first agent prompt." | |
| agent: "Installs NemoClaw, launches a sandbox, and runs the first agent prompt. Use when onboarding, installing, or launching a NemoClaw sandbox for the first time." | |
| description: | |
| main: "Install NemoClaw, launch a sandbox, and run your first agent prompt." | |
| agent: >- | |
| Installs NemoClaw, launches a sandbox, and runs the first agent prompt. | |
| Use when onboarding, installing, or launching a NemoClaw sandbox for the first time. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/get-started/quickstart.md` around lines 5 - 7, The agent description
under the YAML key "description.agent" currently has two sentences on one line;
split them so each sentence is on its own line (one sentence per line) to follow
the "one sentence per line" guideline—edit the value for description.agent so
the first sentence "Installs NemoClaw, launches a sandbox, and runs the first
agent prompt." is on its own line and the second sentence "Use when onboarding,
installing, or launching a NemoClaw sandbox for the first time." is on the
following line.
Comment on lines
+5
to
+7
| description: | ||
| main: "Inspect sandbox health, trace agent behavior, and diagnose problems." | ||
| agent: "Inspects sandbox health, traces agent behavior, and diagnoses problems. Use when monitoring a running sandbox, debugging agent issues, or checking sandbox logs." |
Contributor
There was a problem hiding this comment.
Split sentences to one per line in the agent description.
Line 7 contains two sentences on the same line. As per coding guidelines, one sentence per line is required in source for readable diffs.
📝 Proposed fix
description:
main: "Inspect sandbox health, trace agent behavior, and diagnose problems."
- agent: "Inspects sandbox health, traces agent behavior, and diagnoses problems. Use when monitoring a running sandbox, debugging agent issues, or checking sandbox logs."
+ agent: >-
+ Inspects sandbox health, traces agent behavior, and diagnoses problems.
+ Use when monitoring a running sandbox, debugging agent issues, or checking sandbox logs.📝 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.
Suggested change
| description: | |
| main: "Inspect sandbox health, trace agent behavior, and diagnose problems." | |
| agent: "Inspects sandbox health, traces agent behavior, and diagnoses problems. Use when monitoring a running sandbox, debugging agent issues, or checking sandbox logs." | |
| description: | |
| main: "Inspect sandbox health, trace agent behavior, and diagnose problems." | |
| agent: >- | |
| Inspects sandbox health, traces agent behavior, and diagnoses problems. | |
| Use when monitoring a running sandbox, debugging agent issues, or checking sandbox logs. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/monitoring/monitor-sandbox-activity.md` around lines 5 - 7, The agent
description string in the YAML frontmatter (key "description.agent") contains
two sentences on one line; split them so each sentence is on its own line. Edit
the "agent" value so the first sentence ends on its own line and the second
sentence begins on the next line, preserving text and punctuation and keeping
the "description" and "agent" keys unchanged.
Comment on lines
+5
to
+7
| description: | ||
| main: "Full CLI reference for slash commands and standalone NemoClaw commands." | ||
| agent: "Lists all slash commands and standalone NemoClaw CLI commands. Use when looking up a command, checking command syntax, or browsing the CLI reference." |
Contributor
There was a problem hiding this comment.
Split sentences to one per line in the agent description.
Line 7 contains two sentences on the same line, violating the one-sentence-per-line formatting guideline. As per coding guidelines, "One sentence per line in source (makes diffs readable)."
📝 Proposed fix
description:
main: "Full CLI reference for slash commands and standalone NemoClaw commands."
- agent: "Lists all slash commands and standalone NemoClaw CLI commands. Use when looking up a command, checking command syntax, or browsing the CLI reference."
+ agent: >-
+ Lists all slash commands and standalone NemoClaw CLI commands.
+ Use when looking up a command, checking command syntax, or browsing the CLI reference.📝 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.
Suggested change
| description: | |
| main: "Full CLI reference for slash commands and standalone NemoClaw commands." | |
| agent: "Lists all slash commands and standalone NemoClaw CLI commands. Use when looking up a command, checking command syntax, or browsing the CLI reference." | |
| description: | |
| main: "Full CLI reference for slash commands and standalone NemoClaw commands." | |
| agent: >- | |
| Lists all slash commands and standalone NemoClaw CLI commands. | |
| Use when looking up a command, checking command syntax, or browsing the CLI reference. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/reference/commands.md` around lines 5 - 7, The agent description under
the YAML key "description.agent" currently has two sentences on one line; split
them into two separate lines so each sentence is its own line (preserving YAML
indentation and quotes) — locate the "description.agent" entry and break the
text into one sentence per line while keeping the same content and quoting
style.
Comment on lines
+5
to
+7
| description: | ||
| main: "Configuration reference for NemoClaw routed inference providers." | ||
| agent: "Documents configuration options for NemoClaw routed inference providers. Use when configuring inference profiles, looking up provider routing settings, or reviewing available LLM providers." |
Contributor
There was a problem hiding this comment.
Split sentences to one per line in the agent description.
Line 7 contains two sentences on the same line, violating the one-sentence-per-line formatting guideline. As per coding guidelines, each sentence must appear on its own line in source.
📝 Proposed fix
description:
main: "Configuration reference for NemoClaw routed inference providers."
- agent: "Documents configuration options for NemoClaw routed inference providers. Use when configuring inference profiles, looking up provider routing settings, or reviewing available LLM providers."
+ agent: >-
+ Documents configuration options for NemoClaw routed inference providers.
+ Use when configuring inference profiles, looking up provider routing settings, or reviewing available LLM providers.📝 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.
Suggested change
| description: | |
| main: "Configuration reference for NemoClaw routed inference providers." | |
| agent: "Documents configuration options for NemoClaw routed inference providers. Use when configuring inference profiles, looking up provider routing settings, or reviewing available LLM providers." | |
| description: | |
| main: "Configuration reference for NemoClaw routed inference providers." | |
| agent: >- | |
| Documents configuration options for NemoClaw routed inference providers. | |
| Use when configuring inference profiles, looking up provider routing settings, or reviewing available LLM providers. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/reference/inference-profiles.md` around lines 5 - 7, The agent
description string under the YAML key description.agent contains two sentences
on the same line; split them so each sentence is on its own line (i.e., break
the value of description.agent into two separate lines with the first sentence
on one line and the second sentence on the next) while preserving the existing
wording and YAML indentation.
Comment on lines
+5
to
+7
| description: | ||
| main: "Apache 2.0 license for the NemoClaw project." | ||
| agent: "Contains the Apache 2.0 license for the NemoClaw project. Use when checking the project license or reviewing license terms." |
Contributor
There was a problem hiding this comment.
Split sentences to one per line in the agent description.
Line 7 contains two sentences on the same line. As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
📝 Proposed fix
description:
main: "Apache 2.0 license for the NemoClaw project."
- agent: "Contains the Apache 2.0 license for the NemoClaw project. Use when checking the project license or reviewing license terms."
+ agent: >-
+ Contains the Apache 2.0 license for the NemoClaw project.
+ Use when checking the project license or reviewing license terms.📝 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.
Suggested change
| description: | |
| main: "Apache 2.0 license for the NemoClaw project." | |
| agent: "Contains the Apache 2.0 license for the NemoClaw project. Use when checking the project license or reviewing license terms." | |
| description: | |
| main: "Apache 2.0 license for the NemoClaw project." | |
| agent: >- | |
| Contains the Apache 2.0 license for the NemoClaw project. | |
| Use when checking the project license or reviewing license terms. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/resources/license.md` around lines 5 - 7, The agent description under
the YAML key description.agent contains two sentences on the same line; split
them so each sentence is on its own line (i.e., break the agent value into two
lines, one sentence per line) to follow the "one sentence per line" guideline
and keep the key name description.agent intact.
| description: "What workspace files are, where they live, and how they persist across sandbox restarts." | ||
| description: | ||
| main: "What workspace files are, where they live, and how they persist across sandbox restarts." | ||
| agent: "Explains what workspace files are, where they live, and how they persist across sandbox restarts. Use when asking about soul.md, identity.md, memory.md, agents.md, or sandbox file persistence." |
Contributor
There was a problem hiding this comment.
Use inline code + canonical filename casing in the agent description.
Line 7 references workspace filenames as plain prose (soul.md, etc.). Format these as inline code and match the canonical names used in this doc (SOUL.md, IDENTITY.md, MEMORY.md, AGENTS.md).
Suggested patch
- agent: "Explains what workspace files are, where they live, and how they persist across sandbox restarts. Use when asking about soul.md, identity.md, memory.md, agents.md, or sandbox file persistence."
+ agent: "Explains what workspace files are, where they live, and how they persist across sandbox restarts. Use when asking about `SOUL.md`, `IDENTITY.md`, `MEMORY.md`, `AGENTS.md`, or sandbox file persistence."As per coding guidelines, "CLI commands, file paths, flags, parameter names, and values must use inline code formatting."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/workspace/workspace-files.md` at line 7, The agent description string
uses plain text filenames; update the `agent` description to use inline code
formatting and the canonical uppercase filenames (e.g., `SOUL.md`,
`IDENTITY.md`, `MEMORY.md`, `AGENTS.md`) so CLI/file references follow the doc
guidelines; locate the `agent` field in this document and replace occurrences
like "soul.md", "identity.md", "memory.md", "agents.md" with backticked
`SOUL.md`, `IDENTITY.md`, `MEMORY.md`, `AGENTS.md`.
cv
approved these changes
Apr 3, 2026
cjagwani
pushed a commit
to fdzdev/NemoClaw
that referenced
this pull request
Apr 3, 2026
…VIDIA#1389) <!-- markdownlint-disable MD041 --> ## Summary This change is basically to write description for agents in the docs pages, and let the docs-to-skills script to use that. - Split the flat `description` frontmatter field into `description.main` (readers, SEO, search snippets) and `description.agent` (skill routing, generated SKILL.md) across all 21 doc pages. - Write `description.agent` in third-person voice with "Use when..." clauses so `docs-to-skills.py` uses them verbatim — no more code-side verb conjugation or keyword appending. - Remove ~50 lines of dead code from `docs-to-skills.py`: `extract_trigger_keywords`, `_strip_use_when`, and the unused `keywords` parameter on `build_skill_description`. - Add `_brand_case()` to fix skill H1 titles (`Nemoclaw` → `NemoClaw`). - Update the JSON output extension and search engine to emit and index `description_agent` when it differs from `description`. ## Related Issue <!-- Link to the issue: Fixes #NNN or Closes #NNN. Remove this section if none. --> ## Changes <!-- Bullet list of key changes. --> ## Type of Change <!-- Check the one that applies. --> - [ ] Code change for a new feature, bug fix, or refactor. - [ ] Code change with doc updates. - [ ] Doc only. Prose changes without code sample modifications. - [ ] Doc only. Includes code sample changes. ## Testing <!-- What testing was done? --> - [ ] `npx prek run --all-files` passes (or equivalently `make check`). - [ ] `npm test` passes. - [x] `make docs` builds without warnings. (for doc-only changes) ## Checklist ### General - [x] I have read and followed the [contributing guide](https://github.com/NVIDIA/NemoClaw/blob/main/CONTRIBUTING.md). - [x] I have read and followed the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). (for doc-only changes) ### Code Changes <!-- Skip if this is a doc-only PR. --> - [ ] Formatters applied — `npx prek run --all-files` auto-fixes formatting (or `make format` for targeted runs). - [ ] Tests added or updated for new or changed behavior. - [ ] No secrets, API keys, or credentials committed. - [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs). ### Doc Changes <!-- Skip if this PR has no doc changes. --> - [ ] Follows the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). Try running the `update-docs` agent skill to draft changes while complying with the style guide. For example, prompt your agent with "`/update-docs` catch up the docs for the new changes I made in this PR." - [ ] New pages include SPDX license header and frontmatter, if creating a new page. - [ ] Cross-references and links verified. --- <!-- DCO sign-off (required by CI). Replace with your real name and email. --> Signed-off-by: Your Name <your-email@example.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
lakamsani
pushed a commit
to lakamsani/NemoClaw
that referenced
this pull request
Apr 4, 2026
…VIDIA#1389) <!-- markdownlint-disable MD041 --> ## Summary This change is basically to write description for agents in the docs pages, and let the docs-to-skills script to use that. - Split the flat `description` frontmatter field into `description.main` (readers, SEO, search snippets) and `description.agent` (skill routing, generated SKILL.md) across all 21 doc pages. - Write `description.agent` in third-person voice with "Use when..." clauses so `docs-to-skills.py` uses them verbatim — no more code-side verb conjugation or keyword appending. - Remove ~50 lines of dead code from `docs-to-skills.py`: `extract_trigger_keywords`, `_strip_use_when`, and the unused `keywords` parameter on `build_skill_description`. - Add `_brand_case()` to fix skill H1 titles (`Nemoclaw` → `NemoClaw`). - Update the JSON output extension and search engine to emit and index `description_agent` when it differs from `description`. ## Related Issue <!-- Link to the issue: Fixes #NNN or Closes #NNN. Remove this section if none. --> ## Changes <!-- Bullet list of key changes. --> ## Type of Change <!-- Check the one that applies. --> - [ ] Code change for a new feature, bug fix, or refactor. - [ ] Code change with doc updates. - [ ] Doc only. Prose changes without code sample modifications. - [ ] Doc only. Includes code sample changes. ## Testing <!-- What testing was done? --> - [ ] `npx prek run --all-files` passes (or equivalently `make check`). - [ ] `npm test` passes. - [x] `make docs` builds without warnings. (for doc-only changes) ## Checklist ### General - [x] I have read and followed the [contributing guide](https://github.com/NVIDIA/NemoClaw/blob/main/CONTRIBUTING.md). - [x] I have read and followed the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). (for doc-only changes) ### Code Changes <!-- Skip if this is a doc-only PR. --> - [ ] Formatters applied — `npx prek run --all-files` auto-fixes formatting (or `make format` for targeted runs). - [ ] Tests added or updated for new or changed behavior. - [ ] No secrets, API keys, or credentials committed. - [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs). ### Doc Changes <!-- Skip if this PR has no doc changes. --> - [ ] Follows the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). Try running the `update-docs` agent skill to draft changes while complying with the style guide. For example, prompt your agent with "`/update-docs` catch up the docs for the new changes I made in this PR." - [ ] New pages include SPDX license header and frontmatter, if creating a new page. - [ ] Cross-references and links verified. --- <!-- DCO sign-off (required by CI). Replace with your real name and email. --> Signed-off-by: Your Name <your-email@example.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
gemini2026
pushed a commit
to gemini2026/NemoClaw
that referenced
this pull request
Apr 14, 2026
…VIDIA#1389) <!-- markdownlint-disable MD041 --> ## Summary This change is basically to write description for agents in the docs pages, and let the docs-to-skills script to use that. - Split the flat `description` frontmatter field into `description.main` (readers, SEO, search snippets) and `description.agent` (skill routing, generated SKILL.md) across all 21 doc pages. - Write `description.agent` in third-person voice with "Use when..." clauses so `docs-to-skills.py` uses them verbatim — no more code-side verb conjugation or keyword appending. - Remove ~50 lines of dead code from `docs-to-skills.py`: `extract_trigger_keywords`, `_strip_use_when`, and the unused `keywords` parameter on `build_skill_description`. - Add `_brand_case()` to fix skill H1 titles (`Nemoclaw` → `NemoClaw`). - Update the JSON output extension and search engine to emit and index `description_agent` when it differs from `description`. ## Related Issue <!-- Link to the issue: Fixes #NNN or Closes #NNN. Remove this section if none. --> ## Changes <!-- Bullet list of key changes. --> ## Type of Change <!-- Check the one that applies. --> - [ ] Code change for a new feature, bug fix, or refactor. - [ ] Code change with doc updates. - [ ] Doc only. Prose changes without code sample modifications. - [ ] Doc only. Includes code sample changes. ## Testing <!-- What testing was done? --> - [ ] `npx prek run --all-files` passes (or equivalently `make check`). - [ ] `npm test` passes. - [x] `make docs` builds without warnings. (for doc-only changes) ## Checklist ### General - [x] I have read and followed the [contributing guide](https://github.com/NVIDIA/NemoClaw/blob/main/CONTRIBUTING.md). - [x] I have read and followed the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). (for doc-only changes) ### Code Changes <!-- Skip if this is a doc-only PR. --> - [ ] Formatters applied — `npx prek run --all-files` auto-fixes formatting (or `make format` for targeted runs). - [ ] Tests added or updated for new or changed behavior. - [ ] No secrets, API keys, or credentials committed. - [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs). ### Doc Changes <!-- Skip if this PR has no doc changes. --> - [ ] Follows the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). Try running the `update-docs` agent skill to draft changes while complying with the style guide. For example, prompt your agent with "`/update-docs` catch up the docs for the new changes I made in this PR." - [ ] New pages include SPDX license header and frontmatter, if creating a new page. - [ ] Cross-references and links verified. --- <!-- DCO sign-off (required by CI). Replace with your real name and email. --> Signed-off-by: Your Name <your-email@example.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.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
2 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
This change is basically to write description for agents in the docs pages, and let the docs-to-skills script to use that.
descriptionfrontmatter field intodescription.main(readers, SEO, search snippets) anddescription.agent(skill routing, generated SKILL.md) across all 21 doc pages.description.agentin third-person voice with "Use when..." clauses sodocs-to-skills.pyuses them verbatim — no more code-side verb conjugation or keyword appending.docs-to-skills.py:extract_trigger_keywords,_strip_use_when, and the unusedkeywordsparameter onbuild_skill_description._brand_case()to fix skill H1 titles (Nemoclaw→NemoClaw).description_agentwhen it differs fromdescription.Related Issue
Changes
Type of Change
Testing
npx prek run --all-filespasses (or equivalentlymake check).npm testpasses.make docsbuilds without warnings. (for doc-only changes)Checklist
General
Code Changes
npx prek run --all-filesauto-fixes formatting (ormake formatfor targeted runs).Doc Changes
update-docsagent skill to draft changes while complying with the style guide. For example, prompt your agent with "/update-docscatch up the docs for the new changes I made in this PR."Signed-off-by: Your Name your-email@example.com