Skip to content

docs(agents): point the preset example at presets that exist - #9543

Merged
jyaunches merged 2 commits into
NVIDIA:mainfrom
udsy19:docs/agents-md-preset-paths
Aug 19, 2026
Merged

docs(agents): point the preset example at presets that exist#9543
jyaunches merged 2 commits into
NVIDIA:mainfrom
udsy19:docs/agents-md-preset-paths

Conversation

@udsy19

@udsy19 udsy19 commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Summary

AGENTS.md tells a contributor to follow the structure of slack.yaml and discord.yaml when adding a network policy preset. PR #6129 moved both files to src/lib/messaging/channels/<channel>/policy/<agent>.yaml, so neither name resolves under nemoclaw-blueprint/policies/presets/. This change names two presets that exist in that directory today.

Related Issue

Fixes #9542

Changes

  • AGENTS.md:307 — replace the slack.yaml and discord.yaml examples with github.yaml and brave.yaml.

One line in, one line out. No abstraction, configuration, fallback, migration, or compatibility path is added.

The diff touches one file, not two. CLAUDE.md is a tracked symlink to AGENTS.md (mode 120000, blob content AGENTS.md), so git diff --stat reports 1 file changed, 1 insertion(+), 1 deletion(-) even though both AGENTS.md and CLAUDE.md serve the corrected text. The symlink blob is unchanged.

Why the examples are stale

git log --oneline --diff-filter=D --all on both paths returns one commit:

d13ef6236 refactor(policy): move messaging policies into channels (#6129)

git show --name-status d13ef6236 records both as renames:

R100 nemoclaw-blueprint/policies/presets/discord.yaml -> src/lib/messaging/channels/discord/policy/openclaw.yaml
R100 nemoclaw-blueprint/policies/presets/slack.yaml   -> src/lib/messaging/channels/slack/policy/openclaw.yaml

git ls-files nemoclaw-blueprint/policies/presets/ | grep -i 'slack\|discord' returns nothing on main.

The stale examples do more than fail to resolve. They direct a contributor adding a messaging-channel policy back into the directory that #6129 emptied of messaging policies. CLAUDE.md resolves to this file, so every agent session in this repository reads the guidance.

Why github.yaml and brave.yaml

Both exist in the directory that the preceding line names. brave.yaml uses the protocol: rest endpoint form with a rules list, which matches the structure the removed slack.yaml had. github.yaml uses the access: full form with a binaries list. The pair shows both endpoint shapes the preset schema accepts.

Why no line was added for messaging-channel policies

src/lib/messaging/AGENTS.md:76 already instructs a contributor to add or update src/lib/messaging/channels/<channel>/policy/<agent>.yaml, and AGENTS.md:48 already links that file. src/lib/policy/index.ts:112-115 and schemas/policy-preset.schema.json:5 state the same split in code. A second bullet here would repeat guidance the repository already owns elsewhere.

AGENTS.md:306 (nemoclaw-blueprint/policies/presets/) remains correct. scripts/validate-configs.mts:127 reads that directory.

Scope

I checked the rest of AGENTS.md for the same class of drift: every backticked path-like token, every npm run script against both package.json files, the Vitest project names, the commitlint type list, the engines.node range, and the language column of the architecture table. Line 307 was the only stale reference, so this PR changes only that line.

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)

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification: the change edits two filenames in a contributor-guidance sentence. It changes no executable code, no build input, and no behavior-affecting configuration. The claim it makes is checked directly by git ls-files nemoclaw-blueprint/policies/presets/.
  • Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging)
  • Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification:
  • Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue:

Verification

  • PR description includes a Signed-off-by: line and every commit appears as Verified in GitHub
  • Normal pre-commit, commit-msg, and pre-push hooks passed, or npm run validate:pr passed after refreshing origin/main when hooks were skipped or unavailable — npm run validate:pr exits 0. Every hook reports Passed, including Codebase growth guardrails, Repository checks, markdownlint-cli2, Source-shape test budget, and TypeScript (CLI). I also ran NEMOCLAW_GROWTH_BASE_REF=upstream/main npx prek run --from-ref upstream/main --to-ref HEAD for both the pre-commit and pre-push stages (exit 0; the TypeScript hooks report no files to check, which matches a one-line Markdown diff), and npx commitlint --from upstream/main --to HEAD (exit 0).
  • Targeted behavior tests pass for the current change set, or tests are marked not applicable above — marked not applicable above.
  • Applicable broad gate passed — npm test for broad runtime/test-harness changes; npm run check for repo-wide validation/coverage changes — command/result: not applicable; this PR changes no runtime, test-harness, validation, or coverage input.
  • Quality Gates section completed with required justifications or waivers
  • No secrets, API keys, or credentials committed
  • npm run docs builds without warnings (doc changes only) — npm run docs exits 0 and reports check-docs-published-routes: OK — 68 guarded page(s), native changelog links, and direct legacy redirects and Found 0 errors and 2 warnings. Both warnings are pre-existing and unrelated to this change: Missing redirects check skipped: not authenticated (local run without FERN_TOKEN) and the light-mode accent contrast ratio in the Fern theme. AGENTS.md is not an input to the docs build, and docs/_build/ is gitignored, so this change produces no generated-file churn.
  • Doc pages follow the style guide (doc changes only) — not applicable; AGENTS.md is repository guidance, not a page under docs/.
  • New doc pages include SPDX header and frontmatter (new pages only)

Net line change: git diff --numstat reports 1 1 AGENTS.md. Net zero lines.


Signed-off-by: Udaya Tejas udayatejas2004@gmail.com

Summary by CodeRabbit

  • Documentation
    • Updated network policy preset guidance to reference the current GitHub and Brave presets.

AGENTS.md told a contributor to follow the structure of `slack.yaml` and
`discord.yaml` when adding a network policy preset. Commit d13ef62 moved both
files to `src/lib/messaging/channels/<channel>/policy/<agent>.yaml`, so neither
name resolves under `nemoclaw-blueprint/policies/presets/`. The stale examples
direct a contributor back into the layout that commit removed.

Name `github.yaml` and `brave.yaml` instead. Both exist in that directory today,
and together they show the two endpoint forms the preset schema accepts.

`CLAUDE.md` is a tracked symlink to `AGENTS.md`, so this single-file change also
updates the guidance that `CLAUDE.md` serves.

Signed-off-by: Udaya Tejas <udayatejas2004@gmail.com>
@copy-pr-bot

copy-pr-bot Bot commented Aug 18, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 901b6e4c-9599-4c46-839c-d88044aecf53

📥 Commits

Reviewing files that changed from the base of the PR and between 0ac5a7c and ebba71e.

📒 Files selected for processing (1)
  • AGENTS.md

Included review availability: Your plan provides up to 12 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The contributor guidance now references github.yaml and brave.yaml instead of the removed slack.yaml and discord.yaml presets.

Changes

Policy guidance

Layer / File(s) Summary
Update preset examples
AGENTS.md
The network policy preset guidance now references github.yaml and brave.yaml.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to ebba7

This localized documentation change points contributors to existing preset examples without changing executable code, configuration, or runtime behavior; no actionable merge-blocking risk remains.

🚥 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 describes the documentation change to reference existing presets.
Linked Issues check ✅ Passed The change replaces the stale preset names with github.yaml and brave.yaml as required by issue #9542.
Out of Scope Changes check ✅ Passed The pull request contains only the scoped one-line documentation update required by issue #9542.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@senthilr-nv senthilr-nv added chore Build, CI, dependency, or tooling maintenance area: docs Documentation, examples, guides, or docs build v0.0.111 labels Aug 18, 2026
@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — Informational

Advisor assessment: Informational / low confidence
Next action: No advisor follow-up needed.
Findings: 0 blockers · 0 warnings · 0 suggestions
Status: PR review advisor failed: PR review advisor SDK execution failed: session: challenge-and-record must make exactly 1 submit_review submit attempt(s), with 0 failed and 1 successful completion (observed 2 starts, 1 successful, and 1 failed completions); turn: challenge-and-record: challenge-and-record must make exactly 1 submit_review submit attempt(s), with 0 failed and 1 successful completion (observed 2 starts, 1 successful, and 1 failed completions)

Model lanes

  • GPT-5.6 Terra (primary): Failed
  • Nemotron 3 Ultra (second opinion): Completed · high confidence · 0 blockers · 0 warnings · 0 suggestions

Second-opinion terminology and E2E selections are advisory. Live E2E does not run automatically for pull requests.

E2E guidance

Advisory only. A maintainer can dispatch the default E2E suite for the commit under review.

Recommended E2E: None

Workflow run details

This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge.

@apurvvkumaria apurvvkumaria self-assigned this Aug 19, 2026
@apurvvkumaria

Copy link
Copy Markdown
Collaborator

Documentation writer review: PASS

The replacement examples are accurate and focused:

  • github.yaml and brave.yaml both exist in nemoclaw-blueprint/policies/presets/.
  • Together they show the two current endpoint forms used by presets in that directory.
  • The nearby messaging guide already owns the separate channel-policy location, so repeating that guidance here would add duplication.
  • The one-line change follows the repository writing guide and does not change product behavior or public documentation.

I found no documentation or writing blocker. The PR still needs an independent human approval and successful normal CI before merge.

@apurvvkumaria

Copy link
Copy Markdown
Collaborator

CI classification: review and workflow-owner decision required

All normal documentation, link, DCO, commit, security, and repository checks now pass.

The primary PR Review Advisor completed at high confidence with no blockers, warnings, or suggestions. The second-opinion lane did not complete across its original run and two bounded retries. On the final attempt, it remained in dependency setup for about 40 minutes, was cancelled, and then reported its analysis package unavailable. It did not produce a code finding.

I am not starting another retry. A workflow owner must decide how to repair that advisory lane. The one-line documentation change also still needs an independent human approval. The PR remains blocked; no check will be waived or bypassed.

Signed-off-by: Julie Yaunches <jyaunches@nvidia.com>
@coderabbitai

coderabbitai Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@jyaunches
jyaunches merged commit 43b7471 into NVIDIA:main Aug 19, 2026
40 of 41 checks passed
cjagwani added a commit that referenced this pull request Aug 20, 2026
<!-- markdownlint-disable MD041 -->
## Summary

Add the canonical dated changelog entry required before planning the
v0.0.112 release.
The entry summarizes the 75 merged PRs in
`v0.0.111..af56158`, links user-facing
themes to published documentation routes, and links every included
source PR.

## Changes

- Add `docs/changelog/2026-08-20.mdx` with the exact `## v0.0.112`
release heading and parser-safe MDX SPDX comment.
- Cover managed local inference, onboarding and sandbox lifecycle
recovery, messaging continuity, review and release automation, E2E
qualification, dependency updates, and cumulative documentation
catch-up.
- Preserve the documentation skip list and supported-agent matrix; the
release entry contains none of the blocked terms or excluded
experimental surfaces.

### Source-to-doc mapping

- #8620 -> `docs/changelog/2026-08-20.mdx`: Record the LangChain Deep
Agents Code 0.1.55 update.
- #9192 -> `docs/changelog/2026-08-20.mdx`: Record the OpenShell 0.0.106
update.
- #9240 -> `docs/changelog/2026-08-20.mdx`: Record the cold base-image
pull heartbeat.
- #9412 -> `docs/changelog/2026-08-20.mdx`: Record voice context
preservation across sequential turns.
- #9483 -> `docs/changelog/2026-08-20.mdx`: Record Ollama model
verification through the sandbox endpoint.
- #9493 -> `docs/changelog/2026-08-20.mdx`: Record E2E cloud-check
wiring coverage.
- #9495 -> `docs/changelog/2026-08-20.mdx`: Record Model Router endpoint
health validation.
- #9534 -> `docs/changelog/2026-08-20.mdx`: Record default-sandbox
resolution for tunnel status.
- #9537 -> `docs/changelog/2026-08-20.mdx`: Record Linux AMD64 Muse and
Lightning profiles.
- #9543 -> `docs/changelog/2026-08-20.mdx`: Record corrected
network-policy preset examples.
- #9545 -> `docs/changelog/2026-08-20.mdx`: Record shared
runtime-adapter port validation.
- #9578 -> `docs/changelog/2026-08-20.mdx`: Record Portable network
creation before host aliases.
- #9589 -> `docs/changelog/2026-08-20.mdx`: Record running vLLM profile
validation.
- #9590 -> `docs/changelog/2026-08-20.mdx`: Record the two-turn atomic
advisor review.
- #9597 -> `docs/changelog/2026-08-20.mdx`: Record Portable uninstall
without host-owned lifecycle resources.
- #9605 -> `docs/changelog/2026-08-20.mdx`: Record release automation
for an initially empty tag history.
- #9607 -> `docs/changelog/2026-08-20.mdx`: Record credential retry
navigation.
- #9626 -> `docs/changelog/2026-08-20.mdx`: Record retirement of
DeepSeek V4 Pro from the featured menu.
- #9631 -> `docs/changelog/2026-08-20.mdx`: Record reduction-directed
advisor design blockers.
- #9632 -> `docs/changelog/2026-08-20.mdx`: Record Portable Ollama under
Podman.
- #9633 -> `docs/changelog/2026-08-20.mdx`: Record llama.cpp attachment
without `/props` model aliases.
- #9636 -> `docs/changelog/2026-08-20.mdx`: Record Docker authority
independent of terminal state.
- #9641 -> `docs/changelog/2026-08-20.mdx`: Record the separate Portable
host-gateway subnet.
- #9642 -> `docs/changelog/2026-08-20.mdx`: Record cumulative command
documentation catch-up.
- #9645 -> `docs/changelog/2026-08-20.mdx`: Record removal of completed
advisor rollout compatibility.
- #9647 -> `docs/changelog/2026-08-20.mdx`: Record diagnostics for
OpenShell deletion handoffs.
- #9650 -> `docs/changelog/2026-08-20.mdx`: Record OpenClaw pairing
settlement after route changes.
- #9652 -> `docs/changelog/2026-08-20.mdx`: Record repaired same-turn
advisor submissions.
- #9653 -> `docs/changelog/2026-08-20.mdx`: Record llama.cpp authority
preservation on resume.
- #9654 -> `docs/changelog/2026-08-20.mdx`: Record the schema-owned
Microsoft Teams webhook field.
- #9655 -> `docs/changelog/2026-08-20.mdx`: Record configured managed
vLLM ports.
- #9656 -> `docs/changelog/2026-08-20.mdx`: Record interrupted managed
vLLM installation recovery.
- #9660 -> `docs/changelog/2026-08-20.mdx`: Record catalog-owned vLLM
profiles and refreshed llama.cpp pins.
- #9663 -> `docs/changelog/2026-08-20.mdx`: Record attested LKG
production-image requests.
- #9664 -> `docs/changelog/2026-08-20.mdx`: Record corrected documented
environment-variable handling.
- #9665 -> `docs/changelog/2026-08-20.mdx`: Record retired gateway
evidence validation.
- #9666 -> `docs/changelog/2026-08-20.mdx`: Record Docker authority
across terminal sessions.
- #9667 -> `docs/changelog/2026-08-20.mdx`: Record contribution intake
and product-decision guidance.
- #9669 -> `docs/changelog/2026-08-20.mdx`: Record bounded DGX Spark
llama.cpp request bodies.
- #9670 -> `docs/changelog/2026-08-20.mdx`: Record managed llama.cpp
bridge authentication.
- #9671 -> `docs/changelog/2026-08-20.mdx`: Record gateway recreation
after Docker network loss.
- #9672 -> `docs/changelog/2026-08-20.mdx`: Record bounded WSL Ollama
host probes.
- #9674 -> `docs/changelog/2026-08-20.mdx`: Record cumulative inference
and command documentation catch-up.
- #9675 -> `docs/changelog/2026-08-20.mdx`: Record Muse Glimmer vLLM
image revision handling.
- #9676 -> `docs/changelog/2026-08-20.mdx`: Record the grouped CodeQL
Actions update.
- #9677 -> `docs/changelog/2026-08-20.mdx`: Record the actions/setup-go
7.0.0 update.
- #9678 -> `docs/changelog/2026-08-20.mdx`: Record resumable failed
llama.cpp cleanup.
- #9681 -> `docs/changelog/2026-08-20.mdx`: Record Docker executable
injection in the state-mutation harness.
- #9683 -> `docs/changelog/2026-08-20.mdx`: Record Windows Docker path
fixtures.
- #9684 -> `docs/changelog/2026-08-20.mdx`: Record isolated macOS status
subprocess cleanup.
- #9686 -> `docs/changelog/2026-08-20.mdx`: Record managed-inference
catalog compilation for Portable E2E.
- #9687 -> `docs/changelog/2026-08-20.mdx`: Record cumulative uninstall
documentation catch-up.
- #9688 -> `docs/changelog/2026-08-20.mdx`: Record DCode model-selector
loading through tsx.
- #9689 -> `docs/changelog/2026-08-20.mdx`: Record bounded docs-parity
process starts.
- #9690 -> `docs/changelog/2026-08-20.mdx`: Record reduced advisor
review protocol failures.
- #9691 -> `docs/changelog/2026-08-20.mdx`: Record managed llama.cpp
bridge cleanup coverage.
- #9692 -> `docs/changelog/2026-08-20.mdx`: Record upstream credential
rejection diagnostics.
- #9693 -> `docs/changelog/2026-08-20.mdx`: Record cumulative managed
vLLM documentation catch-up.
- #9694 -> `docs/changelog/2026-08-20.mdx`: Record the pinned Portable
rootless Podman runtime.
- #9695 -> `docs/changelog/2026-08-20.mdx`: Record owned llama.cpp image
publication.
- #9697 -> `docs/changelog/2026-08-20.mdx`: Record Windows-host Ollama
resume behavior.
- #9699 -> `docs/changelog/2026-08-20.mdx`: Record the separate trusted
Windows path oracle.
- #9702 -> `docs/changelog/2026-08-20.mdx`: Record sandbox bridge
cleanup coverage.
- #9703 -> `docs/changelog/2026-08-20.mdx`: Record hardened Ollama
installer downloads.
- #9704 -> `docs/changelog/2026-08-20.mdx`: Record supervised dashboard
recovery evidence.
- #9706 -> `docs/changelog/2026-08-20.mdx`: Record reused model and
reasoning health validation.
- #9708 -> `docs/changelog/2026-08-20.mdx`: Record fixed local vLLM
profile preservation.
- #9711 -> `docs/changelog/2026-08-20.mdx`: Record local registry
authority in E2E runs.
- #9712 -> `docs/changelog/2026-08-20.mdx`: Record Hermes dashboard
migration before gateway health.
- #9720 -> `docs/changelog/2026-08-20.mdx`: Record default OpenClaw
session admission during uninstall.
- #9721 -> `docs/changelog/2026-08-20.mdx`: Record MCP credential
republishing after policy binding.
- #9722 -> `docs/changelog/2026-08-20.mdx`: Record provider republishing
after Docker recreation.
- #9724 -> `docs/changelog/2026-08-20.mdx`: Record reclamation of dead
Shields lifecycle owners.
- #9725 -> `docs/changelog/2026-08-20.mdx`: Record fail-closed
unscripted onboarding prompts.
- #9729 -> `docs/changelog/2026-08-20.mdx`: Record aligned sandbox
launch forward ports.

## Type of Change

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

## Quality Gates

- [ ] Tests added or updated for changed behavior
- [x] Existing tests cover changed behavior — justification:
`test/changelog-docs.test.ts` validates the dated release-entry
contract.
- [ ] Tests not applicable — justification:
- [ ] Sensitive paths changed (security, policy, credentials, preflight,
onboarding, inference, runner, sandbox, or messaging)
- [ ] Sensitive-path review completed or maintainer-approved waiver
recorded — reviewer/approval link/justification:
- [ ] Non-success, skipped, or missing CI check accepted by maintainer —
check name, approval link, and follow-up issue:

## DGX Station Hardware Evidence

- [ ] Tested on DGX Station
- Tested commit: Not applicable; documentation-only change.
- Station profile/scenario: Not applicable.
- Result: Not applicable.
- Supporting evidence: Not applicable.

## Verification

- [x] PR description includes a `Signed-off-by:` line and every commit
appears as `Verified` in GitHub
- [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or
`npm run validate:pr` passed after refreshing `origin/main` when hooks
were skipped or unavailable
- [x] Targeted behavior tests pass for the current change set, or tests
are marked not applicable above — `npx vitest run
test/changelog-docs.test.ts` (7 passed).
- [ ] Applicable broad gate passed — `npm test` for broad
runtime/test-harness changes; `npm run check` for repo-wide
validation/coverage changes — command/result: Not applicable to one
prose-only changelog page.
- [x] Quality Gates section completed with required justifications or
waivers
- [x] No secrets, API keys, or credentials committed
- [ ] `npm run docs` builds without warnings (doc changes only) — passed
with 0 errors and the 2 existing Fern warnings.
- [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)
— the parser-safe MDX SPDX comment is present; native changelog pages
intentionally do not use frontmatter.

---
Signed-off-by: Charan Jagwani <cjagwani@nvidia.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
  * Added release notes for v0.0.112.
* Documented improvements to managed model runtimes, sandbox recovery,
MCP and provider handling, messaging, Shields, and PR Review Advisor.
* Added details on release provenance, end-to-end qualification,
dependency updates, and documentation alignment.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

AGENTS.md points contributors at two network policy presets that no longer exist

4 participants