Skip to content

docs: promote skills and refresh release docs#4547

Merged
miyoungc merged 3 commits into
mainfrom
docs/improve
May 29, 2026
Merged

docs: promote skills and refresh release docs#4547
miyoungc merged 3 commits into
mainfrom
docs/improve

Conversation

@miyoungc
Copy link
Copy Markdown
Collaborator

@miyoungc miyoungc commented May 29, 2026

Summary

Promotes NemoClaw user skills in the most visible docs entry points and refreshes the docs for v0.0.55.
This keeps the public docs and generated user skills aligned with the latest release tag.

Related Issue

None.

Changes

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Verification

  • npx prek run --all-files passes
  • npm test passes
  • Tests added or updated for new or changed behavior
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Verification details:

  • python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx passed.
  • npm run docs passed with 0 errors and the existing Fern light-mode contrast warning.
  • Commit hooks passed for the docs commits.
  • Full all-files/pre-push checks were attempted but hit unrelated CLI test timeouts, so the all-files checkbox is left unchecked.

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

Summary by CodeRabbit

  • Documentation
    • Added Agent Skills guidance and links across overview, getting started, quickstart, and homepage to load NemoClaw user skills into AI coding assistants.
    • Clarified local inference onboarding reliability (retry/timeout behavior and Docker detection) for Ollama/vLLM.
    • Clarified messaging-channel onboarding to skip setup when no channels are selected and Enter is pressed.
    • Improved secret-scanner behavior descriptions and added v0.0.55 release notes.

Review Change Stack

@miyoungc miyoungc added the documentation Improvements or additions to documentation label May 29, 2026
@miyoungc miyoungc self-assigned this May 29, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Documentation across NemoClaw adds and promotes Agent Skills links/site copy and refactors local-inference and onboarding docs to document retry behaviors, an authenticated reverse proxy flow, messaging-step skip behavior, memory-scanner wording, and new v0.0.55 release notes.

Changes

Agent Skills Documentation Integration

Layer / File(s) Summary
Landing page and agent skills promotion
docs/index.mdx
Frontmatter description extended to mention packaged agent skills; added onboarding sentence about user skills; new "Use NemoClaw User Skills" Cards section and an Agent Skills card in the Explore grid.
Getting started guide integration
docs/get-started/quickstart.mdx, docs/get-started/prerequisites.mdx, .agents/skills/nemoclaw-user-get-started/SKILL.md
Added early "Use Agent Skills" tip in quickstart and Next Steps links in quickstart/prerequisites; skill docs reference nemoclaw-user-agent-skills.
Overview & skill references
docs/about/overview.mdx, .agents/skills/nemoclaw-user-overview/references/overview.md
Added "Agent skills" row to Key Features and an "Agent Skills" Next Steps bullet linking to the nemoclaw-user-agent-skills resource.

Onboarding, Local Inference & Reliability

Layer / File(s) Summary
Local inference retry & timeout behavior
docs/inference/use-local-inference.mdx, .agents/skills/nemoclaw-user-configure-inference/SKILL.md
Documented retry of Ollama host-side validation probe timeouts (larger timeout on retry) and retrying Docker runtime detection with a longer docker info timeout before selecting local inference.
Authenticated Reverse Proxy & vLLM non-interactive setup
.agents/skills/nemoclaw-user-configure-inference/references/use-local-inference-details.md, .agents/skills/nemoclaw-user-configure-inference/SKILL.md
Introduced detailed Authenticated Reverse Proxy guidance (proxy port, token generation/permissions, lifecycle, sandbox probe validation, token-injection at egress), non-interactive env examples and variable tables, and vLLM non-interactive/managed install notes.
Messaging-step skip, memory scanner wording, and release notes
docs/manage-sandboxes/messaging-channels.mdx, docs/get-started/quickstart.mdx, .agents/skills/*, .agents/skills/nemoclaw-user-configure-security/references/best-practices.md, docs/about/release-notes.mdx, .agents/skills/nemoclaw-user-overview/references/release-notes.md
Clarified onboarding behavior: pressing Enter with no selected messaging channels skips messaging setup across docs and skills; refined Memory Secret Scanner description to enumerate its three path-classifier cases enforced by isMemoryPath(); added v0.0.55 release notes covering these changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#4026: Related messaging-channels onboarding prompt change that matches the "press Enter with no channels selected to skip" behavior documented here.
  • NVIDIA/NemoClaw#4539: Touches generated local-inference skill docs and restructures Ollama onboarding details similar to the changes in this PR.
  • NVIDIA/NemoClaw#4438: Related to exporting/signing agent skills; this PR updates underlying skill content and links that would be included in such exports.

Suggested labels

enhancement: skill

Suggested reviewers

  • jyaunches
  • cv

Poem

🐰 A rabbit hops through docs so bright,
Adding agent skills to guide the night.
Retries and proxies now described just right,
Messaging skips when channels take flight—
Hooray! Docs tidy, users delight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main changes: promoting user skills and refreshing release documentation across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/improve

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 29, 2026

E2E Advisor Recommendation

Required E2E: None
Optional E2E: None

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

  • None. No E2E is recommended because this PR only changes documentation and agent skill reference Markdown/MDX content. The diff does not modify installer/onboarding code, sandbox lifecycle implementation, credentials handling, security enforcement, network policy assets, inference routing code, deployment workflows, or executable user-flow logic.

Optional E2E

  • None.

New E2E recommendations

  • None.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 29, 2026

E2E Scenario Advisor Recommendation

Required scenario E2E: None
Optional scenario E2E: None

Workflow run

Full scenario advisor summary

E2E Scenario Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required scenario E2E

  • None. Docs and agent-skill content changes only; no files under test/e2e-scenario/, scenario workflows, scenario metadata, expected-state contracts, suite definitions, runtime, suite scripts, or onboarding/install helper code that can affect scenario E2E behavior.

Optional scenario E2E

  • None.

Relevant changed files

  • None.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 29, 2026

PR Review Advisor

Findings: 0 needs attention, 1 worth checking, 0 nice ideas
Since last review: 2 prior items resolved, 0 still apply, 1 new item found

Review findings

🛠️ Needs attention

  • None.

🔎 Worth checking

  • Published catalog skills still appear stale (skills/nemoclaw-user-get-started/SKILL.md:13): This PR refreshes the source docs and .agents generated user skills, but the root skills/ catalog export appears to still contain pre-refresh content. That means users who consume the published/catalog skill copies can miss the new Agent Skills onboarding guidance and the v0.0.55 release/inference/security updates even though the source docs and .agents copies were updated.
    • Recommendation: Refresh the root skills/nemoclaw-user-* catalog export from the updated .agents/skills sources, preserving or regenerating signing artifacts according to the catalog publishing flow, or explicitly document that this PR intentionally defers the catalog refresh to a separate signing PR.
    • Evidence: skills/README.md says the root skills directory is a generated catalog export derived from .agents/skills, and .github/catalog-skills-signing-flow.md calls out drift between source /.agents/skills/ and published /skills/. Spot checks show skills/nemoclaw-user-get-started/SKILL.md lacks the new Use Agent Skills tip now present in .agents/skills/nemoclaw-user-get-started/SKILL.md; skills/nemoclaw-user-overview/references/overview.md lacks the new Agent skills feature row; and skills/nemoclaw-user-overview/references/release-notes.md starts at v0.0.53 instead of the new v0.0.55 notes.

🌱 Nice ideas

  • None.
Since last review details

Current findings:

  • Published catalog skills still appear stale (skills/nemoclaw-user-get-started/SKILL.md:13): This PR refreshes the source docs and .agents generated user skills, but the root skills/ catalog export appears to still contain pre-refresh content. That means users who consume the published/catalog skill copies can miss the new Agent Skills onboarding guidance and the v0.0.55 release/inference/security updates even though the source docs and .agents copies were updated.
    • Recommendation: Refresh the root skills/nemoclaw-user-* catalog export from the updated .agents/skills sources, preserving or regenerating signing artifacts according to the catalog publishing flow, or explicitly document that this PR intentionally defers the catalog refresh to a separate signing PR.
    • Evidence: skills/README.md says the root skills directory is a generated catalog export derived from .agents/skills, and .github/catalog-skills-signing-flow.md calls out drift between source /.agents/skills/ and published /skills/. Spot checks show skills/nemoclaw-user-get-started/SKILL.md lacks the new Use Agent Skills tip now present in .agents/skills/nemoclaw-user-get-started/SKILL.md; skills/nemoclaw-user-overview/references/overview.md lacks the new Agent skills feature row; and skills/nemoclaw-user-overview/references/release-notes.md starts at v0.0.53 instead of the new v0.0.55 notes.

Workflow run details

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

@miyoungc miyoungc changed the title docs: promote user skills in onboarding docs docs: promote skills and refresh release docs May 29, 2026
@miyoungc miyoungc added the v0.0.55 Release target label May 29, 2026
@miyoungc miyoungc enabled auto-merge (squash) May 29, 2026 20:37
@miyoungc miyoungc merged commit 9f63738 into main May 29, 2026
32 of 33 checks passed
@miyoungc miyoungc deleted the docs/improve branch May 29, 2026 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation v0.0.55 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants