docs: move docs-to-skills refresh into update-docs skill as release prep steps & user-skills refresh#3067
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR restructures the docs-to-skills release-prep flow (removes an Actions workflow, updates pre-commit and contributor SKILL steps), adds Brev Web UI deployment docs, expands inference (vLLM) and CLI/troubleshooting/security docs, and deletes or clears several reference pages. ChangesDocs-to-Skills & Release-Prep Workflow
Deploy-Remote & Brev Web UI
Inference: vLLM & Local Inference Options
CLI, Troubleshooting & Security Docs
Reference Removals / Cleared Files
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~25 minutes
🚥 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 |
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/CONTRIBUTING.md (1)
67-69:⚠️ Potential issue | 🟠 Major | ⚡ Quick winUse
consolecode blocks with$prompts for CLI commands.These command examples are currently formatted as
bashblocks without shell prompts, which violates the docs style requirements for CLI snippets.Suggested fix
-```bash -python scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user +```console +$ python scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user```diff -```bash -python scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --dry-run +```console +$ python scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --dry-run</details> As per coding guidelines: “CLI code blocks must use the `console` language tag with `$` prompt prefix. Flag ```bash or ```shell for CLI examples.” Also applies to: 75-77 <details> <summary>🤖 Prompt for AI Agents</summary>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/CONTRIBUTING.mdaround lines 67 - 69, The CLI examples use abash block without a shell prompt; change those code fences to useconsole and
prefix each command line with "$ " (e.g. replace "bash\npython scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user" with "console\n$ python scripts/docs-to-skills.py docs/ .agents/skills/ --prefix
nemoclaw-user" and do the same for the dry-run example containing "python
scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user
--dry-run" and the other occurrence at lines 75-77 so the docs follow the CLI
code block style rules).</details> </blockquote></details> </blockquote></details>🤖 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 @.agents/skills/nemoclaw-user-deploy-remote/references/brev-web-ui.md: - Around line 93-97: The note block in the pairing section is malformed (it begins with ":>" and ends with "**Connect**.:")—open the original docs source (the pairing section that generates .agents/skills/nemoclaw-user-deploy-remote/references/brev-web-ui.md), replace the leading ":>" with a proper Markdown note/blockquote (e.g., "> **Note:**") and remove the stray trailing period+colon after "**Connect**", ensure the paragraph text remains unchanged otherwise, save the docs file, and then regenerate the skills so the corrected note renders in the autogenerated .agents/skills Markdown. --- Outside diff comments: In `@docs/CONTRIBUTING.md`: - Around line 67-69: The CLI examples use a ```bash block without a shell prompt; change those code fences to use ```console and prefix each command line with "$ " (e.g. replace "```bash\npython scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user" with "```console\n$ python scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user" and do the same for the dry-run example containing "python scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --dry-run" and the other occurrence at lines 75-77 so the docs follow the CLI code block style rules).🪄 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:
52f77020-75ea-4af4-80f8-c1dd381622b8📒 Files selected for processing (13)
.agents/skills/nemoclaw-contributor-update-docs/SKILL.md.agents/skills/nemoclaw-skills-guide/SKILL.md.agents/skills/nemoclaw-user-configure-security/references/best-practices.md.agents/skills/nemoclaw-user-deploy-remote/SKILL.md.agents/skills/nemoclaw-user-deploy-remote/references/brev-web-ui.md.agents/skills/nemoclaw-user-get-started/SKILL.md.agents/skills/nemoclaw-user-reference/references/commands.md.agents/skills/nemoclaw-user-reference/references/troubleshooting.md.github/workflows/docs-to-skills.yaml.pre-commit-config.yamlAGENTS.mdCONTRIBUTING.mddocs/CONTRIBUTING.md💤 Files with no reviewable changes (1)
- .github/workflows/docs-to-skills.yaml
Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/CONTRIBUTING.md (1)
1-1:⚠️ Potential issue | 🟠 Major | ⚡ Quick winAdd the SPDX header at the top of this docs page.
Line 1 starts the page content without the required Markdown SPDX header.
Suggested fix
+<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. --> +<!-- SPDX-License-Identifier: Apache-2.0 --> + # Contributing to NemoClaw DocumentationAs per coding guidelines: every
**/*.{js,ts,tsx,jsx,sh,md}source file must include the SPDX license header, and Markdown must use HTML comments.🤖 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/CONTRIBUTING.md` at line 1, Add the required Markdown SPDX header as an HTML comment at the very top of CONTRIBUTING.md (before the "# Contributing..." line); insert the project’s standard SPDX tag (e.g. <!-- SPDX-License-Identifier: MIT --> or the org’s canonical identifier) as the first line so the file complies with the rule that all `*.md` sources include an HTML-comment SPDX header.CONTRIBUTING.md (1)
1-1:⚠️ Potential issue | 🟠 Major | ⚡ Quick winAdd the required SPDX header at the top of this Markdown file.
Line 1 starts with content before the required license header, which violates the repository-wide SPDX rule for
.mdfiles.Suggested fix
+<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. --> +<!-- SPDX-License-Identifier: Apache-2.0 --> + # Contributing to NVIDIA NemoClawAs per coding guidelines: every
**/*.{js,ts,tsx,jsx,sh,md}source file must include the SPDX license header, using HTML comments for Markdown.🤖 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 `@CONTRIBUTING.md` at line 1, Add the required SPDX license header as an HTML comment at the very top of CONTRIBUTING.md (i.e., insert the repository's SPDX header before the existing "# Contributing to NVIDIA NemoClaw" line) so the file conforms to the repo-wide SPDX rule for .md files; use the same SPDX identifier string used in other source files in the repo.
🤖 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/CONTRIBUTING.md`:
- Around line 63-66: Update the release-prep regeneration command so it
explicitly uses python3: replace the line containing "python
scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user" with
"python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user"
in CONTRIBUTING.md (the command string "python scripts/docs-to-skills.py ..." is
the unique token to find and edit).
---
Outside diff comments:
In `@CONTRIBUTING.md`:
- Line 1: Add the required SPDX license header as an HTML comment at the very
top of CONTRIBUTING.md (i.e., insert the repository's SPDX header before the
existing "# Contributing to NVIDIA NemoClaw" line) so the file conforms to the
repo-wide SPDX rule for .md files; use the same SPDX identifier string used in
other source files in the repo.
In `@docs/CONTRIBUTING.md`:
- Line 1: Add the required Markdown SPDX header as an HTML comment at the very
top of CONTRIBUTING.md (before the "# Contributing..." line); insert the
project’s standard SPDX tag (e.g. <!-- SPDX-License-Identifier: MIT --> or the
org’s canonical identifier) as the first line so the file complies with the rule
that all `*.md` sources include an HTML-comment SPDX header.
🪄 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: 3961b4bc-e980-4325-bf59-9f14d4688ce9
📒 Files selected for processing (5)
.agents/skills/nemoclaw-contributor-update-docs/SKILL.md.pre-commit-config.yamlAGENTS.mdCONTRIBUTING.mddocs/CONTRIBUTING.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 @.agents/skills/nemoclaw-contributor-update-docs/SKILL.md:
- Line 160: The example flow in SKILL.md shows "python3
scripts/docs-to-skills.py ..." as an unconditional step while the narrative
above it makes skills refresh conditional for release-prep; update the example
so that the command is explicitly marked or wrapped as conditional (e.g., append
"(release-prep only)" or prefix with "If preparing a release:") to match the
text, and make the same change in the docs/ source that generates
.agents/skills/SKILL.md so the change is preserved on regen; specifically locate
and edit the docs template that emits the example sequence and the line that
emits the literal "python3 scripts/docs-to-skills.py" to include the conditional
note and ensure consistency for the step currently referenced around the
"docs-to-skills.py" invocation.
🪄 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: 78aadc55-42f4-4e1c-bcac-d99567625b65
📒 Files selected for processing (1)
.agents/skills/nemoclaw-contributor-update-docs/SKILL.md
Summary
Moves generated
nemoclaw-user-*skill refreshes out of the deleted post-merge automation and into the maintainer release-prep docs flow. Normal docs PRs now stay source-only underdocs/, while hooks validate the docs-to-skills conversion in dry-run mode.Related Issue
None.
Changes
Docs to SkillsGitHub Actions workflow that regenerated user skills after merge.docs/CONTRIBUTING.md, rootCONTRIBUTING.md, andAGENTS.mdto define user skills, avoid generated output in normal docs PRs, and document release-prep regeneration.nemoclaw-contributor-update-docsso release prep includes version bumps, user-skill refreshes, PR description source summaries, and documentation labeling guidance.nemoclaw-user-*skills from the current docs, including updated inference, deployment, security, reference, and troubleshooting skill content.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)Additional verification: latest commit and push hooks passed, including
Verify docs-to-skills output,markdownlint-cli2,gitleaks, andTest (skills YAML).Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Made with Cursor
Summary by CodeRabbit
Release Notes
New Features
Documentation
Chores