Skip to content

Commit 7aa998c

Browse files
authored
docs(skills): refactor d2s script (#4549)
<!-- markdownlint-disable MD041 --> ## Summary Refactors `scripts/docs-to-skills.py` to a simpler two-strategy generator (`grouped` and `individual`) and regenerates `.agents/skills/nemoclaw-user-*` output to match. The old `smart` strategy, 11,500-character spill logic, and `*-details.md` deferral files are removed; sibling pages now land in `references/` unchanged, and procedure pages inline in full when they lead a group. ## Related Issue None. ## Changes **Generator (`scripts/docs-to-skills.py`)** - Replace `smart` default with `grouped` (directory groups) and keep `individual` (one skill per procedure page; concept/reference buckets). - **Grouped lead selection:** highest-priority procedure page (`how_to`, `get_started`, or `tutorial`) becomes `SKILL.md` body; all siblings go to `references/`. - **Reference-only hubs:** groups with no procedure page (for example `overview`, `reference`, `configure-security`) emit a thin `SKILL.md` with frontmatter + `## References` only; full content stays in `references/`. - Remove `MAX_SKILL_MD_CHARS`, section splitting/deferral, and generated `*-details.md` spill files. - Fix skill description ordering to follow the partitioned lead page. - Fix markdownlint MD012 in generated hub skills (`collapse_consecutive_blank_lines`, `append_markdown_section`). **Docs source tweaks** - `docs/about/overview.mdx`: add `skill.priority: 10` for overview ordering in generated metadata. - `docs/resources/agent-skills.mdx`: set `content.type` to `how_to` so the single-page group inlines correctly. **Regenerated user skills** - Inline full procedure content where it leads: `get-started` (quickstart + provider options), `configure-inference`, `manage-policy`, `manage-sandboxes`, `deploy-remote`, `monitor-sandbox`, `agent-skills`. - Convert heavy groups to reference hubs: `overview`, `reference`, `configure-security`. - Delete obsolete spill files: `quickstart-details.md`, `use-local-inference-details.md`, `customize-network-policy-details.md`, `lifecycle-details.md`, `agent-skills.md`. **Docs pipeline docs** - Update `docs/CONTRIBUTING.md` grouped-strategy description. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [x] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Design notes (reviewer follow-ups) - **Reference-only hub skills are intentional.** Concept/reference directory groups defer all page bodies to `references/` so agents load detail on demand (progressive disclosure). Routing text lives in `SKILL.md` frontmatter + References bullets; full task coverage remains in sibling reference files. - **`resolve_includes()` path containment** is pre-existing MyST-only behavior; this PR does not expand its surface. Follow-up hardening can be a separate change if we want docs-root allowlisting. ## Verification - [x] `npx prek run --all-files` passes (via CI `checks`) - [x] `npm test` passes (via CI `unit-vitest-linux`) - [ ] Tests added or updated for new or changed behavior - [x] No secrets, API keys, or credentials committed - [x] Docs updated for user-facing behavior changes - [x] `npm run docs` builds without warnings (doc changes only; Fern preview posted) - [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) **Local commands run:** ```bash python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx --dry-run python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx ``` --- Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
1 parent 843cf36 commit 7aa998c

17 files changed

Lines changed: 716 additions & 920 deletions

File tree

.agents/skills/nemoclaw-user-agent-skills/SKILL.md

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,84 @@ license: "Apache-2.0"
99

1010
# NemoClaw Agent Skills for Your AI Coding Assistant
1111

12-
## References
12+
NemoClaw ships agent skills that are generated directly from this documentation.
13+
Each skill is a converted version of one or more doc pages, structured so AI coding assistants can consume it as context.
14+
This means you can interact with the full NemoClaw documentation as skills inside your agent chat session, instead of reading the docs separately.
1315

14-
- **Load [references/agent-skills.md](references/agent-skills.md)** when users ask about AI agent support, coding assistant integration, or the .agents/skills/ directory. Describes the agent skills shipped with NemoClaw and how to access them by cloning the repository.
16+
Ask your assistant a question about NemoClaw and it responds with the same guidance found in these docs, adapted to your current situation.
17+
Skills cover installation, inference configuration, network policy management, monitoring, deployment, security, workspace management, and the CLI reference.
18+
19+
**Note:**
20+
21+
If you are a contributor and have cloned the full NemoClaw repository, the full set of skills including contributor and maintainer skills are already available at the project root.
22+
Open the `NemoClaw` directory in your coding assistant and the skills load automatically.
23+
This page is for users who installed NemoClaw with the installer and do not have a local clone.
24+
25+
## Get the Skills
26+
27+
Fetch only the skills from the NemoClaw repository without downloading the full source tree.
28+
29+
```console
30+
$ git clone --filter=blob:none --no-checkout https://github.com/NVIDIA/NemoClaw.git
31+
$ cd NemoClaw
32+
$ git sparse-checkout set --no-cone '/.agents/skills/nemoclaw-user-*/**' '/.agents/skills/nemoclaw-skills-guide/**' '/.claude/**' '/AGENTS.md' '/CLAUDE.md'
33+
$ git checkout
34+
```
35+
36+
Open the `NemoClaw` directory in your AI coding assistant.
37+
The assistant discovers the skills in `.agents/skills/` and uses them to answer NemoClaw questions with project-specific guidance.
38+
39+
You can keep the skills inside the cloned directory or copy `.agents/skills/` to a global location (such as `~/.cursor/skills/` or `~/.claude/skills/`) so they are available across all your projects.
40+
The choice depends on whether you want NemoClaw skills scoped to one workspace or accessible everywhere.
41+
42+
## Update the Skills
43+
44+
The sparse checkout filter is saved, so `git pull` fetches only updated skills without downloading the full source tree.
45+
Run `git pull` after each NemoClaw release to pick up new and updated skills.
46+
47+
## Available Skills
48+
49+
The following user skills ship with NemoClaw.
50+
51+
| Skill | Summary |
52+
|-------|---------|
53+
| `nemoclaw-user-overview` | What NemoClaw is, ecosystem placement (OpenClaw + OpenShell + NemoClaw), how it works internally, and release notes. |
54+
| `nemoclaw-user-get-started` | Install NemoClaw, launch a sandbox, and run the first agent prompt. |
55+
| `nemoclaw-user-configure-inference` | Choose inference providers during onboarding, switch models without restarting, and set up local inference servers (Ollama, vLLM, TensorRT-LLM, NIM). |
56+
| `nemoclaw-user-manage-policy` | Approve or deny blocked egress requests in the TUI and customize the sandbox network policy (add, remove, or modify allowed endpoints). |
57+
| `nemoclaw-user-monitor-sandbox` | Check sandbox health, read logs, and trace agent behavior to diagnose problems. |
58+
| `nemoclaw-user-deploy-remote` | Deploy NemoClaw to a remote GPU instance, set up the Telegram bridge, and review sandbox container hardening. |
59+
| `nemoclaw-user-configure-security` | Review the risk framework for every configurable security control, understand credential storage, and assess posture trade-offs. |
60+
| `nemoclaw-user-manage-sandboxes` | Manage day-two sandbox operations, including status, logs, diagnostics, rebuilds, upgrades, messaging channels, workspace files, backup, and restore. |
61+
| `nemoclaw-user-reference` | CLI command reference, plugin and blueprint architecture, baseline network policies, and troubleshooting guide. |
62+
63+
## Example Questions and Triggered Skills
64+
65+
After opening the cloned repository in your coding assistant, ask a NemoClaw question in natural language.
66+
The assistant matches your question to the relevant skill and follows the guidance it contains.
67+
68+
Examples of questions your assistant can answer with these skills:
69+
70+
| Question | Skill triggered |
71+
|----------|-----------------|
72+
| "How do I install NemoClaw?" | `nemoclaw-user-get-started` |
73+
| "Switch my inference provider to Ollama." | `nemoclaw-user-configure-inference` |
74+
| "A network request was blocked. How do I approve it?" | `nemoclaw-user-manage-policy` |
75+
| "Show me the sandbox logs." | `nemoclaw-user-monitor-sandbox` |
76+
| "How do I deploy NemoClaw to a remote GPU?" | `nemoclaw-user-deploy-remote` |
77+
| "What security controls can I configure?" | `nemoclaw-user-configure-security` |
78+
| "Back up my agent workspace files." | `nemoclaw-user-manage-sandboxes` |
79+
| "What CLI commands are available?" | `nemoclaw-user-reference` |
80+
81+
You can also reference a skill directly by name if you know which one you need.
82+
83+
## AI Coding Assistants that You Can Use with NemoClaw Skills
84+
85+
The NemoClaw agent skills follow the [Agent Skills best practices](https://agentskills.io/skill-creation/best-practices) and the [Claude Skills best practices](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices).
86+
The following table shows how each AI coding assistant can use the NemoClaw skills.
87+
88+
| Assistant | Skill discovery |
89+
|-----------|----------------|
90+
| Cursor | Reads `AGENTS.md` at the project root, which references `.agents/skills/`. |
91+
| Claude Code | Follows the `.claude/skills/` symlink, which points to `.agents/skills/`. |
92+
| Other assistants | Point the assistant to `.agents/skills/` if it supports project-level skill loading. |

.agents/skills/nemoclaw-user-agent-skills/references/agent-skills.md

Lines changed: 0 additions & 85 deletions
This file was deleted.

0 commit comments

Comments
 (0)