Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/workflows/docs-preview-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ on:
- "README.md"
- "package.json"
- "package-lock.json"
- "scripts/generate-starter-prompt.ts"
- "scripts/sync-agent-variant-docs.ts"
- ".github/workflows/docs-preview-pr.yaml"

concurrency:
Expand Down Expand Up @@ -56,8 +58,10 @@ jobs:
- name: Install docs dependencies
run: npm ci --ignore-scripts

- name: Validate docs
run: npm run docs
- name: Prepare and validate docs
run: |
npm run docs:prepare
npm run docs:validate

- name: Generate preview URL
if: ${{ steps.fern-preview.outputs.enabled == 'true' }}
Expand All @@ -66,7 +70,6 @@ jobs:
FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
PREVIEW_ID: pr-${{ github.event.pull_request.number }}
run: |
npm run docs:check-agent-variants
FERN_VERSION=$(node -p "require('./fern/fern.config.json').version")
set +e
OUTPUT=$(cd fern && npx --yes "fern-api@${FERN_VERSION}" generate --docs --instance "$FERN_STAGING_INSTANCE" --preview --id "$PREVIEW_ID" 2>&1)
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/docs-publish-public.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ jobs:
- name: Install docs dependencies
run: npm ci --ignore-scripts

- name: Generate doc variants and validate Fern docs
- name: Prepare and validate Fern docs
run: |
npm run docs:sync-agent-variants
npm run docs
npm run docs:prepare
npm run docs:validate

- name: Publish public docs
env:
Expand Down
7 changes: 4 additions & 3 deletions .github/workflows/docs-publish-staging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
- "fern/**"
- "package.json"
- "package-lock.json"
- "scripts/generate-starter-prompt.ts"
- "scripts/sync-agent-variant-docs.ts"
- ".github/workflows/docs-publish-staging.yaml"

Expand Down Expand Up @@ -43,10 +44,10 @@ jobs:
- name: Install docs dependencies
run: npm ci --ignore-scripts

- name: Generate doc variants and validate Fern docs
- name: Prepare and validate Fern docs
run: |
npm run docs:sync-agent-variants
npm run docs
npm run docs:prepare
npm run docs:validate

- name: Publish staging docs
env:
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ repos:
name: Repository checks
entry: npm run checks
language: system
files: ^(\.pre-commit-config\.yaml$|\.github/workflows/e2e\.yaml$|Dockerfile(?:\.base)?$|agents/openclaw/manifest\.yaml$|agents/hermes/(?:Dockerfile(?:\.base)?|manifest\.yaml|mcp-config-transaction\.py)$|nemoclaw-blueprint/blueprint\.yaml$|nemoclaw/package\.json$|scripts/(?:brev-launchable-ci-cpu|check-installer-hash|install-openshell|update-hermes-agent)\.sh$|src/lib/actions/sandbox/openshell-child-visible-credentials\.v[0-9]+\.[0-9]+\.[0-9]+\.json$|bin/.*\.(cjs|js|mjs)$|src/.*\.(cts|mts|ts|tsx)$|scripts/.*\.(cjs|cts|js|mjs|mts|ts|tsx)$|test/.*\.(cjs|cts|js|mjs|mts|ts|tsx)$|nemoclaw/src/.*\.(cts|mts|ts|tsx)$)
files: ^(\.pre-commit-config\.yaml$|\.github/workflows/e2e\.yaml$|Dockerfile(?:\.base)?$|agents/openclaw/manifest\.yaml$|agents/hermes/(?:Dockerfile(?:\.base)?|manifest\.yaml|mcp-config-transaction\.py)$|docs/resources/starter-prompt\.md$|nemoclaw-blueprint/blueprint\.yaml$|nemoclaw/package\.json$|scripts/(?:brev-launchable-ci-cpu|check-installer-hash|install-openshell|update-hermes-agent)\.sh$|src/lib/actions/sandbox/openshell-child-visible-credentials\.v[0-9]+\.[0-9]+\.[0-9]+\.json$|bin/.*\.(cjs|js|mjs)$|src/.*\.(cts|mts|ts|tsx)$|scripts/.*\.(cjs|cts|js|mjs|mts|ts|tsx)$|test/.*\.(cjs|cts|js|mjs|mts|ts|tsx)$|nemoclaw/src/.*\.(cts|mts|ts|tsx)$)
pass_filenames: false
priority: 10

Expand Down
27 changes: 27 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,33 @@ Public docs publish automatically when a `v*.*.*` release tag is pushed.
The public publish job runs in the `docs-public` environment, verifies that the tag commit is reachable from `origin/main`, regenerates agent variants, validates Fern docs, and publishes to the public Fern instance.
If the tag does not point to a commit on `main`, the job stops before installing dependencies or running Fern.

## Starter Prompt Generation

The canonical coding-agent installation prompt lives in `docs/resources/starter-prompt.md`.
Edit that Markdown file instead of placing prompt text in a React component.
Downstream consumers can pin the source with a raw URL such as
`https://raw.githubusercontent.com/NVIDIA/NemoClaw/<commit-sha>/docs/resources/starter-prompt.md`.
Comment on lines +116 to +117

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Keep one sentence per Markdown line.

Lines 116-117 split one sentence across two lines. Keep the sentence on one line or introduce the URL as a separate sentence.

As per coding guidelines, Markdown documentation must use one sentence per line and end every sentence with a period.

🤖 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` around lines 116 - 117, Update the documentation text
around the downstream-consumer raw URL so each sentence occupies one Markdown
line and ends with a period. Keep the URL example intact, either placing the
entire sentence on one line or making the URL introduction a separate complete
sentence.

Source: Coding guidelines

The Markdown SPDX comment is part of that raw file but does not appear when Markdown is rendered.

The `scripts/generate-starter-prompt.ts` script removes the Markdown SPDX preamble and writes `docs/_build/StarterPrompt.generated.mdx`.
The generated snippet wraps the prompt in Fern's native visible `Prompt` component, which displays the prompt body and supplies the copy button.
The generated file is ignored by Git and is recreated by the docs build.

Run the generator directly when you need to inspect the generated snippet:

```bash
npm run docs:sync-starter-prompt
```

Run the read-only comparison after generation when you need to verify that the snippet matches the Markdown source:

```bash
npm run docs:check-starter-prompt
```

The shared `npm run docs:prepare` step generates the Starter Prompt and agent variants.
The normal `npm run docs`, `npm run docs:live`, agent-variant sync, preview-watcher, and docs publish workflows run that step before Fern validates, serves, previews, or publishes the pages that include the prompt.

## Agent Variant Generation

Some Fern pages appear in the OpenClaw, Hermes, and Deep Agents guide variants.
Expand Down
175 changes: 0 additions & 175 deletions docs/_components/StarterPromptButton.tsx

This file was deleted.

13 changes: 4 additions & 9 deletions docs/get-started/quickstart-hermes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,20 @@ content:
skill:
priority: 20
---
import { StarterPromptFallback } from "../_components/StarterPrompt";
import { StarterPromptButton } from "../_components/StarterPromptButton";

Create a sandboxed Hermes agent, then chat with it from the dashboard or terminal.
The `nemohermes` command is the NemoClaw CLI with Hermes pre-selected.

## Set Up with a Coding Agent
## Set Up with the Starter Prompt on Your Coding Agent

Copy this starter prompt into Cursor, Claude Code, Codex, Copilot, or another local coding agent when you want it to guide the installation.
The prompt points the agent to [AI Agent Docs](../resources/agent-skills), this quickstart, the Markdown docs, and the optional `nemoclaw-user-guide` skill.
It asks the agent to confirm Hermes before it runs commands that create a sandbox or receive credentials and to use the checked-in local credential helper and form only after you approve the exact command that receives credentials.

<StarterPromptButton />

<StarterPromptFallback />
<Markdown src="/../docs/_build/StarterPrompt.generated.mdx" />

If you prefer to control setup directly, use the interactive installer in [Create Your First Sandboxed Agent](#create-your-first-sandboxed-agent).
If you prefer to control setup directly, use [Set Up with the Interactive Installer on Your Terminal](#set-up-with-the-interactive-installer-on-your-terminal).

## Create Your First Sandboxed Agent
## Set Up with the Interactive Installer on Your Terminal

If you use the coding-agent prompt in the preceding section, you can skip this procedure or keep it as reference.
The prompt directs your coding agent to this quickstart, so it has the full setup context.
Expand Down
13 changes: 4 additions & 9 deletions docs/get-started/quickstart-langchain-deepagents-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,20 @@ status: published
content:
type: "get_started"
---
import { StarterPromptFallback } from "../_components/StarterPrompt";
import { StarterPromptButton } from "../_components/StarterPromptButton";

Create a sandboxed LangChain Deep Agents Code agent, then run your first prompt.
The `nemo-deepagents` command is an alias for `nemoclaw` with the `langchain-deepagents-code` agent pre-selected.

## Set Up with a Coding Agent
## Set Up with the Starter Prompt on Your Coding Agent

Copy this starter prompt into Cursor, Claude Code, Codex, Copilot, or another local coding agent when you want it to guide the installation.
The prompt points the agent to [AI Agent Docs](../resources/agent-skills), this quickstart, the Markdown docs, and the optional `nemoclaw-user-guide` skill.
It asks the agent to confirm LangChain Deep Agents Code before it runs commands that create a sandbox or receive credentials and to use the checked-in local credential helper and form only after you approve the exact command that receives credentials.

<StarterPromptButton />

<StarterPromptFallback />
<Markdown src="/../docs/_build/StarterPrompt.generated.mdx" />

If you prefer to control setup directly, use the interactive installer in [Create Your First Sandboxed Agent](#create-your-first-sandboxed-agent).
If you prefer to control setup directly, use [Set Up with the Interactive Installer on Your Terminal](#set-up-with-the-interactive-installer-on-your-terminal).

## Create Your First Sandboxed Agent
## Set Up with the Interactive Installer on Your Terminal

If you use the coding-agent prompt in the preceding section, you can skip this procedure or keep it as reference.
The prompt directs your coding agent to this quickstart, so it has the full setup context.
Expand Down
13 changes: 4 additions & 9 deletions docs/get-started/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,19 @@ content:
skill:
priority: 10
---
import { StarterPromptFallback } from "../_components/StarterPrompt";
import { StarterPromptButton } from "../_components/StarterPromptButton";

Create a sandboxed OpenClaw agent, then send it a first prompt.

## Set Up with a Coding Agent
## Set Up with the Starter Prompt on Your Coding Agent

Copy this starter prompt into Cursor, Claude Code, Codex, Copilot, or another local coding agent when you want it to guide the installation.
The prompt points the agent to [AI Agent Docs](../resources/agent-skills), this quickstart, the Markdown docs, and the optional `nemoclaw-user-guide` skill.
It asks the agent to collect your choices before it starts interactive commands and to use the checked-in local credential helper and form only after you approve the exact command that receives credentials.

<StarterPromptButton />

<StarterPromptFallback />
<Markdown src="/../docs/_build/StarterPrompt.generated.mdx" />

If you prefer to control setup directly, use the interactive installer in [Create Your First Sandboxed Agent](#create-your-first-sandboxed-agent).
If you prefer to control setup directly, use [Set Up with the Interactive Installer on Your Terminal](#set-up-with-the-interactive-installer-on-your-terminal).

## Create Your First Sandboxed Agent
## Set Up with the Interactive Installer on Your Terminal

If you use the coding-agent prompt in the preceding section, you can skip this procedure or keep it as reference.
The prompt directs your coding agent to this quickstart, so it has the full setup context.
Expand Down
10 changes: 3 additions & 7 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ position: 1

import { BadgeLinks } from "./_components/BadgeLinks";
import { CommandTerminal } from "./_components/CommandTerminal";
import { StarterPromptFallback } from "./_components/StarterPrompt";
import { StarterPromptButton } from "./_components/StarterPromptButton";

<BadgeLinks
badges={[
Expand Down Expand Up @@ -44,12 +42,10 @@ Install NemoClaw and run the onboard wizard to get started.

### From Your Coding Agent

Copy the starter prompt and paste it into your local coding agent, such as Cursor, Claude Code, Codex, Copilot, or another assistant that can run local commands with your approval.
The prompt tells your agent to use NemoClaw skills when available, bootstrap the docs-routing skill when it is missing, fetch the Markdown docs, ask whether you want OpenClaw, Hermes, or Deep Agents, collect choices one question at a time, and use the checked-in local credential helper and form after you approve the exact command that will receive the credentials.
Copy the starter prompt into your local coding agent for a guided NemoClaw setup.
It helps you choose an agent to run in an OpenShell sandbox, asks one question at a time, handles credentials locally and securely, and asks for approval before running commands.

<StarterPromptButton />

<StarterPromptFallback />
<Markdown src="/../docs/_build/StarterPrompt.generated.mdx" />

### From Your Terminal

Expand Down
Loading
Loading