Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 2 additions & 0 deletions .agents/skills/nemoclaw-contributor-update-docs/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ Write the doc update following these conventions:
- **Start sections with an introductory sentence** that orients the reader.
- **No superlatives.** Say what the feature does, not how great it is.
- **Copyable code examples use language-specific fences** such as `bash`, `sh`, or `powershell`, without prompt markers.
- **Shared NemoClaw CLI examples use `$$nemoclaw`.** In shared OpenClaw/Hermes variant pages, write host CLI examples with the `$$nemoclaw` build-time placeholder so the docs build renders `nemoclaw` on OpenClaw pages and `nemohermes` on Hermes pages before Fern renders fenced code blocks.
- **Do not duplicate code blocks for binary-name-only differences.** Use one fenced block with `$$nemoclaw` when the only difference is `nemoclaw` versus `nemohermes`; keep `<AgentOnly>` only when the surrounding text, flags, behavior, or setup steps actually differ.
- **Use `console` only for terminal transcripts** that include prompts, output, or interactive sessions.
- **Include the SPDX header** if creating a new page.
- **Match existing frontmatter format** if creating a new page.
Expand Down
14 changes: 6 additions & 8 deletions .github/workflows/docs-preview-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,23 @@ jobs:
with:
node-version: "24"

- name: Install Fern CLI
run: |
FERN_VERSION=$(node -p "require('./fern/fern.config.json').version")
npm install -g "fern-api@${FERN_VERSION}"
- name: Install docs dependencies
run: npm ci --ignore-scripts

- name: Validate docs
working-directory: ./fern
run: fern check
run: npm run docs

- name: Generate preview URL
if: ${{ steps.fern-preview.outputs.enabled == 'true' }}
id: generate-docs
env:
FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
PREVIEW_ID: pr-${{ github.event.pull_request.number }}
working-directory: ./fern
run: |
npm run docs:check-agent-variants
FERN_VERSION=$(node -p "require('./fern/fern.config.json').version")
set +e
OUTPUT=$(fern generate --docs --preview --id "$PREVIEW_ID" 2>&1)
OUTPUT=$(cd fern && npx --yes "fern-api@${FERN_VERSION}" generate --docs --preview --id "$PREVIEW_ID" 2>&1)
STATUS=$?
set -e
echo "$OUTPUT"
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ __pycache__/
coverage/
dist/
docs/_build/
docs/**/*.generated.mdx
node_modules/

# OS metadata
Expand Down
8 changes: 7 additions & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,15 @@ These patterns are common in LLM-generated text and erode trust with technical r
Put only the command text in copyable blocks:

```bash
nemoclaw onboard
$$nemoclaw onboard
```

- Use `$$nemoclaw` as a build-time placeholder for NemoClaw host CLI command examples in shared variant pages.
The docs build resolves it to `nemoclaw` for OpenClaw pages and `nemohermes` for Hermes pages before Fern renders code blocks.
This preserves Fern's native fenced-code UI while keeping one source sample.
- Do not write duplicate `<AgentOnly>` fenced code blocks when the only difference is `nemoclaw` versus `nemohermes`.
Use `<AgentOnly>` blocks only when the surrounding content differs between the OpenClaw and Hermes variants.

- Use `powershell` for Windows PowerShell commands.
Use `bash` or `sh` for Linux, macOS, and WSL shell commands.
Reserve `console` blocks for terminal transcripts that include prompts, output, or interactive sessions.
Expand Down
4 changes: 2 additions & 2 deletions docs/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ navigation:
collapsed: open-by-default
contents:
- page: "Manage Sandbox Lifecycle"
path: manage-sandboxes/lifecycle.mdx
path: manage-sandboxes/lifecycle.openclaw.generated.mdx
slug: lifecycle
- page: "Runtime Controls"
path: manage-sandboxes/runtime-controls.mdx
Expand Down Expand Up @@ -222,7 +222,7 @@ navigation:
collapsed: open-by-default
contents:
- page: "Manage Sandbox Lifecycle"
path: manage-sandboxes/lifecycle.mdx
path: manage-sandboxes/lifecycle.hermes.generated.mdx
slug: lifecycle
- page: "Runtime Controls"
path: manage-sandboxes/runtime-controls.mdx
Expand Down
Loading
Loading