Skip to content

Commit 21c74f6

Browse files
committed
Merge origin/main into fix/validate-sandbox-names
2 parents 31765d5 + 20d0c95 commit 21c74f6

183 files changed

Lines changed: 8278 additions & 5573 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.agents/skills/update-docs-from-commits/SKILL.md renamed to .agents/skills/update-docs/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: update-docs-from-commits
2+
name: update-docs
33
description: Scan recent git commits for changes that affect user-facing behavior, then draft or update the corresponding documentation pages. Use when docs have fallen behind code changes, after a batch of features lands, or when preparing a release. Trigger keywords - update docs, draft docs, docs from commits, sync docs, catch up docs, doc debt, docs behind, docs drift.
44
---
55

‎.coderabbit.yaml‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
2+
language: "en-US"
3+
early_access: false
4+
reviews:
5+
profile: "chill"
6+
request_changes_workflow: false
7+
high_level_summary: true
8+
poem: true
9+
review_status: true
10+
review_details: false
11+
auto_review:
12+
enabled: true
13+
drafts: false
14+
path_instructions:
15+
- path: "docs/**"
16+
instructions: |
17+
You are an editorial reviewer for NemoClaw documentation.
18+
Review every docs change against the style guide below. Flag violations
19+
inline as review comments. Do not rewrite the content — point out the
20+
issue and cite the relevant rule so the author can fix it.
21+
22+
## Voice and Tone
23+
24+
- Active voice required. Flag passive constructions.
25+
Bad: "A gateway is created by the CLI."
26+
Good: "The CLI creates a gateway."
27+
- Second person ("you") when addressing the reader.
28+
- Present tense. Flag future tense ("will") in descriptions of current behavior.
29+
- No hedge words: flag "simply," "just," "easily," "of course."
30+
31+
## LLM-Generated Patterns (Flag These)
32+
33+
These are common in AI-generated text and erode trust with technical readers.
34+
Flag every occurrence:
35+
36+
- Unnecessary bold on routine instructions ("This is a **critical** step"
37+
when nothing is actually critical). Bold is reserved for UI labels,
38+
parameter names, and genuine warnings.
39+
- Excessive em dashes. One per paragraph is fine; multiple per paragraph
40+
or em dashes used instead of commas/periods should be flagged.
41+
- Superlatives and marketing language ("powerful," "robust," "seamless,"
42+
"cutting-edge"). Say what it does, not how great it is.
43+
- Emoji in documentation prose.
44+
- Rhetorical questions ("Want to secure your agents? Look no further!").
45+
State the purpose directly.
46+
- Filler introductions ("In this section, we will explore..."). Start
47+
with the content.
48+
49+
## Formatting Rules
50+
51+
- Every sentence must end with a period.
52+
- One sentence per line in source (makes diffs readable). Flag paragraphs
53+
where multiple sentences appear on the same line.
54+
- CLI commands, file paths, flags, parameter names, and values must use
55+
inline `code` formatting.
56+
- CLI code blocks must use the `console` language tag with `$` prompt
57+
prefix. Flag ```bash or ```shell for CLI examples.
58+
- Use MyST admonitions (:::{tip}, :::{note}, :::{warning}) for callouts,
59+
not bold text or blockquotes.
60+
- No nested admonitions.
61+
- Do not number section titles. Flag "Section 1: ...", "Step 3: ...", etc.
62+
- No colons in titles. Flag "Inference: Cloud and Local" — should be
63+
"Cloud and Local Inference."
64+
- Colons should only introduce a list. Flag colons used as general
65+
punctuation between clauses.
66+
67+
## Word List (Flag Incorrect Usage)
68+
69+
| Correct | Incorrect (flag these) |
70+
|----------------|------------------------------------------------------|
71+
| NVIDIA | Nvidia, nvidia |
72+
| NemoClaw | nemoclaw (in prose), Nemoclaw |
73+
| OpenClaw | openclaw (in prose), Openclaw |
74+
| OpenShell | Open Shell, openShell, Openshell, openshell (in prose)|
75+
| CLI | cli, Cli |
76+
| API key | api key, API Key |
77+
| mTLS | MTLS, mtls |
78+
| YAML | yaml (in prose), Yaml |
79+
| gateway | Gateway (unless starting a sentence) |
80+
| sandbox | Sandbox (unless starting a sentence) |
81+
82+
Words inside code blocks or inline code spans are exempt from the word
83+
list (e.g., `nemoclaw onboard` is correct).
84+
85+
## Page Structure
86+
87+
When reviewing new pages, verify:
88+
- SPDX license header is present after frontmatter.
89+
- Frontmatter includes title, description, keywords, topics, tags,
90+
content type, difficulty, audience, and status fields.
91+
- H1 heading matches the `title.page` frontmatter value.
92+
- Page starts with a one- or two-sentence introduction.
93+
- Sections use H2 and H3, each starting with an introductory sentence.
94+
- A "Next Steps" section at the bottom links to related pages.
95+
96+
## Severity
97+
98+
- Word list and voice violations: flag as suggestions.
99+
- Missing SPDX header, broken cross-references, or incorrect code
100+
block language: flag as issues.
101+
- LLM-generated patterns (bold overuse, em dashes, superlatives,
102+
hedge words): flag as suggestions with the note "LLM pattern detected."
103+
- path: "**/*.md"
104+
instructions: |
105+
This rule applies to all Markdown files project-wide. For files
106+
under docs/, the stricter docs/** rules defined earlier in this
107+
file take precedence; this rule adds baseline checks for every
108+
other Markdown file (README, CONTRIBUTING, architecture docs, etc.).
109+
110+
- NVIDIA must be all caps (not Nvidia, nvidia).
111+
- NemoClaw, OpenClaw, and OpenShell must use correct casing.
112+
- No emoji in technical prose.
113+
chat:
114+
auto_reply: true
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Bug Report
2+
description: Report a bug you confirmed and could not fix.
3+
labels: ["bug", "status: triage"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: What happened? What did you expect to happen?
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: reproduction
15+
attributes:
16+
label: Reproduction Steps
17+
description: Minimal steps to reproduce the issue.
18+
placeholder: |
19+
1. Run `nemoclaw onboard`
20+
2. Select "local" inference
21+
3. ...
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: environment
27+
attributes:
28+
label: Environment
29+
description: OS, Node.js version, Docker version, NemoClaw version, and any other relevant details.
30+
placeholder: |
31+
- OS: macOS 15.2 / Ubuntu 24.04 / Windows 11 + WSL2
32+
- Node.js: v20.x
33+
- Docker: Docker Desktop 4.x / Docker Engine 27.x
34+
- NemoClaw: v0.x.x (output of `nemoclaw --version`)
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: debug-output
40+
attributes:
41+
label: Debug Output
42+
description: |
43+
Run `nemoclaw debug --output /tmp/nemoclaw-debug.tar.gz` and attach the
44+
tarball, or paste the output of `nemoclaw debug --quick` below.
45+
render: shell
46+
validations:
47+
required: false
48+
49+
- type: textarea
50+
id: logs
51+
attributes:
52+
label: Logs
53+
description: Any additional log output, error messages, or stack traces not covered by the debug output above.
54+
render: shell
55+
validations:
56+
required: false
57+
58+
- type: checkboxes
59+
id: checklist
60+
attributes:
61+
label: Checklist
62+
options:
63+
- label: I confirmed this bug is reproducible
64+
required: true
65+
- label: I searched existing issues and this is not a duplicate
66+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security vulnerability?
4+
url: https://github.com/NVIDIA/NemoClaw/blob/main/SECURITY.md
5+
about: >
6+
Do not report security vulnerabilities through GitHub issues. Follow
7+
the disclosure process in SECURITY.md.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Documentation Issue
2+
description: Report incorrect, missing, or unclear documentation.
3+
labels: ["documentation", "status: triage"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: What is wrong, missing, or unclear in the docs?
10+
validations:
11+
required: true
12+
13+
- type: input
14+
id: page
15+
attributes:
16+
label: Affected Page
17+
description: URL or file path of the doc page (e.g., docs/get-started/quickstart.md).
18+
placeholder: docs/reference/commands.md
19+
validations:
20+
required: false
21+
22+
- type: dropdown
23+
id: issue-type
24+
attributes:
25+
label: Issue Type
26+
options:
27+
- "Inaccurate information"
28+
- "Missing documentation"
29+
- "Unclear or confusing"
30+
- "Broken link or cross-reference"
31+
- "Formatting or rendering problem"
32+
- "Other"
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: suggestion
38+
attributes:
39+
label: Suggested Fix
40+
description: If you know what the correct content should be, describe it here.
41+
validations:
42+
required: false
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Feature Request
2+
description: Propose a feature with a design. Not a "please build this" request.
3+
labels: ["enhancement", "status: triage"]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: Problem Statement
9+
description: What problem does this solve? Why does it matter?
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: design
15+
attributes:
16+
label: Proposed Design
17+
description: |
18+
How should this work? Describe the system behavior, components involved, and user-facing interface.
19+
This should be a design, not a wish list.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Alternatives Considered
27+
description: What other approaches did you evaluate? Why is the proposed design better?
28+
validations:
29+
required: false
30+
31+
- type: dropdown
32+
id: category
33+
attributes:
34+
label: Category
35+
options:
36+
- "enhancement: feature"
37+
- "enhancement: provider"
38+
- "enhancement: platform"
39+
- "enhancement: testing"
40+
validations:
41+
required: true
42+
43+
- type: checkboxes
44+
id: checklist
45+
attributes:
46+
label: Checklist
47+
options:
48+
- label: I searched existing issues and this is not a duplicate
49+
required: true
50+
- label: This is a design proposal, not a "please build this" request
51+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Summary
2+
<!-- 1-3 sentences: what this PR does and why. -->
3+
4+
## Related Issue
5+
<!-- Link to the issue: Fixes #NNN or Closes #NNN. Remove this section if none. -->
6+
7+
## Changes
8+
<!-- Bullet list of key changes. -->
9+
10+
## Type of Change
11+
<!-- Check the one that applies. -->
12+
- [ ] Code change for a new feature, bug fix, or refactor.
13+
- [ ] Code change with doc updates.
14+
- [ ] Doc only. Prose changes without code sample modifications.
15+
- [ ] Doc only. Includes code sample changes.
16+
17+
## Testing
18+
<!-- What testing was done? -->
19+
- [ ] `make check` passes.
20+
- [ ] `npm test` passes.
21+
- [ ] `make docs` builds without warnings. (for doc-only changes)
22+
23+
## Checklist
24+
25+
### General
26+
- [ ] I have read and followed the [contributing guide](CONTRIBUTING.md).
27+
- [ ] I have read and followed the [style guide](docs/CONTRIBUTING.md). (for doc-only changes)
28+
29+
### Code Changes
30+
<!-- Skip if this is a doc-only PR. -->
31+
- [ ] `make format` applied (TypeScript and Python).
32+
- [ ] Tests added or updated for new or changed behavior.
33+
- [ ] No secrets, API keys, or credentials committed.
34+
- [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs).
35+
36+
### Doc Changes
37+
<!-- Skip if this PR has no doc changes. -->
38+
- [ ] Follows the [style guide](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."
39+
- [ ] New pages include SPDX license header and frontmatter, if creating a new page.
40+
- [ ] Cross-references and links verified.
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
name: Docs PR Preview
5+
6+
on:
7+
pull_request:
8+
branches: [main]
9+
types: [opened, reopened, synchronize, closed]
10+
paths:
11+
- "docs/**"
12+
- "README.md"
13+
- "pyproject.toml"
14+
- "uv.lock"
15+
- ".github/workflows/docs-preview-pr.yaml"
16+
17+
concurrency:
18+
group: preview-${{ github.ref }}
19+
cancel-in-progress: true
20+
21+
permissions:
22+
contents: write
23+
pull-requests: write
24+
25+
jobs:
26+
preview:
27+
runs-on: ubuntu-latest
28+
timeout-minutes: 10
29+
steps:
30+
- name: Checkout
31+
uses: actions/checkout@v4
32+
33+
- name: Set up Python
34+
if: github.event.action != 'closed'
35+
uses: actions/setup-python@v5
36+
with:
37+
python-version: "3.11"
38+
39+
- name: Install uv
40+
if: github.event.action != 'closed'
41+
uses: astral-sh/setup-uv@v4
42+
43+
- name: Install doc dependencies
44+
if: github.event.action != 'closed'
45+
run: uv sync --group docs
46+
47+
- name: Build documentation
48+
if: github.event.action != 'closed'
49+
run: uv run --group docs sphinx-build -W -b html docs docs/_build/html
50+
51+
- name: Clean build artifacts
52+
if: github.event.action != 'closed'
53+
run: |
54+
find docs/_build -name .doctrees -prune -exec rm -rf {} \;
55+
find docs/_build -name .buildinfo -exec rm {} \;
56+
touch docs/_build/html/.nojekyll
57+
58+
- name: Deploy preview
59+
uses: rossjrw/pr-preview-action@v1
60+
with:
61+
source-dir: ./docs/_build/html/
62+
preview-branch: gh-pages
63+
umbrella-dir: pr-preview
64+
action: auto

0 commit comments

Comments
 (0)