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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions .agents/skills/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ SPDX-License-Identifier: Apache-2.0

# Maintainer Skills

This directory is the maintainer-only skill set for developing NeMo Flow
This directory is the maintainer-only skill set for developing NeMo Relay
itself.

Use these skills for repository work such as:
Expand All @@ -15,5 +15,5 @@ Use these skills for repository work such as:
- Extending middleware or observability internals
- Validating library changes across bindings

Consumer-facing NeMo Flow usage skills live in the top-level `skills/`
Consumer-facing NeMo Relay usage skills live in the top-level `skills/`
directory so they can be exported separately for integrators and end users.
18 changes: 9 additions & 9 deletions .agents/skills/add-binding-feature/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: add-binding-feature
description: Add or change a public NeMo Flow API surface across the core runtime and every affected binding
description: Add or change a public NeMo Relay API surface across the core runtime and every affected binding
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand Down Expand Up @@ -32,7 +32,7 @@ Do not use this skill for:
2. **FFI / shared C surface**
Add or update FFI wrappers in the relevant `crates/ffi/src/api/*.rs`
module, re-export them through `crates/ffi/src/api/mod.rs`, and ensure the
generated `crates/ffi/nemo_flow.h` stays correct.
generated `crates/ffi/nemo_relay.h` stays correct.
3. **Language-native bindings**
Update Python, Go, Node.js, and WebAssembly for every surface that should expose the
capability.
Expand All @@ -50,10 +50,10 @@ Do not use this skill for:

| Layer | Convention | Example |
|-------------|-------------------|--------------------------------------|
| Rust | `snake_case` | `nemo_flow_tool_call` |
| C FFI | `nemo_flow_` prefix | `nemo_flow_tool_call` |
| Python | `snake_case` | `nemo_flow.tools.call` |
| Go | `PascalCase` | `nemo_flow.ToolCall` |
| Rust | `snake_case` | `nemo_relay_tool_call` |
| C FFI | `nemo_relay_` prefix | `nemo_relay_tool_call` |
| Python | `snake_case` | `nemo_relay.tools.call` |
| Go | `PascalCase` | `nemo_relay.ToolCall` |
| Node.js | `camelCase` | `toolCall` |
| WebAssembly | `camelCase` | `toolCall` |

Expand All @@ -66,9 +66,9 @@ Do not use this skill for:
re-export in `crates/ffi/src/api/mod.rs`
- [ ] Regenerate the shared library/header path with `just build-go`
- [ ] Python native binding in `crates/python/src/py_api/mod.rs`
- [ ] Python wrapper with docstring in `python/nemo_flow/<module>.py`
- [ ] Python type stubs updated in the relevant `python/nemo_flow/*.pyi` modules
- [ ] Go wrapper in `go/nemo_flow/nemo_flow.go` with doc comment
- [ ] Python wrapper with docstring in `python/nemo_relay/<module>.py`
- [ ] Python type stubs updated in the relevant `python/nemo_relay/*.pyi` modules
- [ ] Go wrapper in `go/nemo_relay/nemo_relay.go` with doc comment
- [ ] Go shorthand package updated if the capability belongs there
- [ ] Node.js binding in `crates/node/src/api/mod.rs`
- [ ] WebAssembly binding in `crates/wasm/src/api/mod.rs`
Expand Down
18 changes: 9 additions & 9 deletions .agents/skills/add-integration/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: add-integration
description: Add a new third-party framework integration maintained as a NeMo Flow patch set
description: Add a new third-party framework integration maintained as a NeMo Relay patch set
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand All @@ -14,7 +14,7 @@ Use `karpathy-guidelines` alongside this skill for implementation or review
work. Keep changes scoped, surface assumptions, and define focused validation
before editing.

NeMo Flow integrations with upstream projects are maintained as manifest-pinned
NeMo Relay integrations with upstream projects are maintained as manifest-pinned
local upstream checkouts under `third_party/`, bootstrapped from
`third_party/sources.lock`, with corresponding patch files in `patches/`.

Expand All @@ -24,9 +24,9 @@ exists and you are refreshing an existing patch set, use

## Required Patterns

- `nemo_flow` stays an optional dependency
- Framework behavior must fall back cleanly when NeMo Flow is unavailable
- Tool calls and LLM calls should use NeMo Flow managed execution where possible
- `nemo_relay` stays an optional dependency
- Framework behavior must fall back cleanly when NeMo Relay is unavailable
- Tool calls and LLM calls should use NeMo Relay managed execution where possible
- Scope creation should mirror the framework's natural agent, graph, or function
boundaries
- Scope stack propagation must be explicit across worker threads or async
Expand Down Expand Up @@ -68,16 +68,16 @@ This root command is the stable public wrapper. The implementation lives under

```
third_party/<name>/ # local upstream checkout pinned by third_party/sources.lock
patches/<name>/ # tracked NeMo Flow integration patch set
0001-add-nemo-flow-integration.patch
patches/<name>/ # tracked NeMo Relay integration patch set
0001-add-nemo-relay-integration.patch
```

## Checklist

- [ ] Upstream checkout exists under `third_party/`
- [ ] Optional import / activation guard is in place
- [ ] Tool calls are wrapped through NeMo Flow where appropriate
- [ ] LLM calls are wrapped through NeMo Flow where appropriate
- [ ] Tool calls are wrapped through NeMo Relay where appropriate
- [ ] LLM calls are wrapped through NeMo Relay where appropriate
- [ ] Scope boundaries match the framework's execution model
- [ ] Context propagation is correct across async or thread boundaries
- [ ] Integration patch regenerates cleanly into `patches/<name>/`
Expand Down
8 changes: 4 additions & 4 deletions .agents/skills/add-middleware/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: add-middleware
description: Add a new guardrail or intercept type to the NeMo Flow middleware pipeline
description: Add a new guardrail or intercept type to the NeMo Relay middleware pipeline
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand All @@ -14,7 +14,7 @@ Use `karpathy-guidelines` alongside this skill for implementation or review
work. Keep changes scoped, surface assumptions, and define focused validation
before editing.

NeMo Flow supports guardrails (validate/gate) and intercepts (transform) at various
NeMo Relay supports guardrails (validate/gate) and intercepts (transform) at various
pipeline stages. Adding a new middleware type requires changes across all layers.

Use this skill when introducing a new middleware registration surface or adding
Expand Down Expand Up @@ -54,7 +54,7 @@ See `docs/about/concepts/middleware.md` for the full diagrams.
pub type MyNewFn = Box<dyn Fn(&str, Json) -> Json + Send + Sync>;
```

2. Add the registry field to `NemoFlowContextState` in
2. Add the registry field to `NemoRelayContextState` in
`crates/core/src/api/runtime/state.rs`.

Add a `SortedRegistry<GuardrailEntry<MyNewFn>>` or `SortedRegistry<Intercept<MyNewFn>>`
Expand All @@ -66,7 +66,7 @@ Use the existing `global_*_registry_api!` and `scope_*_registry_api!` macro
patterns in `crates/core/src/api/registry.rs`. Both global and scope-local
variants are needed unless the design explicitly rules one out.

4. Add chain execution helpers to `NemoFlowContextState` in
4. Add chain execution helpers to `NemoRelayContextState` in
`crates/core/src/api/runtime/state.rs`.

Follow the pattern of `tool_sanitize_request_chain` or `tool_request_intercepts_chain`.
Expand Down
2 changes: 1 addition & 1 deletion .agents/skills/contribute-api/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: contribute-api
description: Contribute a new NeMo Flow public API surface safely, with binding parity and docs in mind
description: Contribute a new NeMo Relay public API surface safely, with binding parity and docs in mind
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand Down
2 changes: 1 addition & 1 deletion .agents/skills/contribute-docs/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: contribute-docs
description: Contribute documentation or example changes that stay aligned with NeMo Flow public behavior
description: Contribute documentation or example changes that stay aligned with NeMo Relay public behavior
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand Down
6 changes: 3 additions & 3 deletions .agents/skills/contribute-integration/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: contribute-integration
description: Contribute a new or updated third-party framework integration for NeMo Flow
description: Contribute a new or updated third-party framework integration for NeMo Relay
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand All @@ -19,8 +19,8 @@ as LangChain, LangGraph, or another patched third-party project.

## Default Guidance

- Keep NeMo Flow optional
- Preserve the framework's original behavior when NeMo Flow is absent
- Keep NeMo Relay optional
- Preserve the framework's original behavior when NeMo Relay is absent
- Wrap tool and LLM paths at the correct framework boundary
- Keep the tracked patch artifact minimal and reproducible

Expand Down
2 changes: 1 addition & 1 deletion .agents/skills/maintain-ci/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: maintain-ci
description: Maintain and review NeMo Flow GitHub Actions workflows with explicit per-job permissions, pinned action SHAs, deterministic caching, reusable workflow permission boundaries, and local validation
description: Maintain and review NeMo Relay GitHub Actions workflows with explicit per-job permissions, pinned action SHAs, deterministic caching, reusable workflow permission boundaries, and local validation
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand Down
6 changes: 3 additions & 3 deletions .agents/skills/maintain-integration-patches/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: maintain-integration-patches
description: Refresh, rebase, regenerate, and validate existing NeMo Flow third-party integration patches
description: Refresh, rebase, regenerate, and validate existing NeMo Relay third-party integration patches
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand All @@ -14,7 +14,7 @@ Use `karpathy-guidelines` alongside this skill for implementation or review
work. Keep changes scoped, surface assumptions, and define focused validation
before editing.

Use this skill when an existing `patches/<name>/0001-add-nemo-flow-integration.patch`
Use this skill when an existing `patches/<name>/0001-add-nemo-relay-integration.patch`
has drifted against the pinned upstream checkout or needs regeneration after
local changes.

Expand Down Expand Up @@ -54,7 +54,7 @@ This root command is the stable public wrapper. The implementation lives under
- Do not apply patches on top of a dirty upstream checkout unless you explicitly
understand and intend the merge state.
- Prefer the repo patch scripts over ad hoc `git diff > patch` workflows.
- Keep the patch minimal and focused on the NeMo Flow integration surface.
- Keep the patch minimal and focused on the NeMo Relay integration surface.
- If upstream drift changes behavior, update docs or test expectations in the
same branch.

Expand Down
2 changes: 1 addition & 1 deletion .agents/skills/maintain-observability/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: maintain-observability
description: Maintain or extend NeMo Flow observability surfaces across ATIF, OpenTelemetry, and OpenInference
description: Maintain or extend NeMo Relay observability surfaces across ATIF, OpenTelemetry, and OpenInference
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand Down
10 changes: 5 additions & 5 deletions .agents/skills/maintain-optimizer/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: maintain-optimizer
description: Maintain or extend the NeMo Flow adaptive surface across config, plugins, docs, and bindings; use this when users still say optimizer
description: Maintain or extend the NeMo Relay adaptive surface across config, plugins, docs, and bindings; use this when users still say optimizer
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand Down Expand Up @@ -38,10 +38,10 @@ See `docs/plugins/adaptive/configuration.md` and

- `crates/adaptive`
- Shared plugin behavior in core and bindings
- Python adaptive/plugin wrappers in `python/nemo_flow/adaptive.py` and
`python/nemo_flow/plugin.py`
- Go adaptive helpers under `go/nemo_flow/adaptive` plus shared plugin
helpers in `go/nemo_flow`
- Python adaptive/plugin wrappers in `python/nemo_relay/adaptive.py` and
`python/nemo_relay/plugin.py`
- Go adaptive helpers under `go/nemo_relay/adaptive` plus shared plugin
helpers in `go/nemo_relay`
- Node/WebAssembly adaptive helpers and plugin wrappers
- Docs and examples that show canonical config shapes

Expand Down
8 changes: 4 additions & 4 deletions .agents/skills/maintain-packaging/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: maintain-packaging
description: Maintain NeMo Flow package metadata, module paths, generated artifacts, and release-facing build surfaces
description: Maintain NeMo Relay package metadata, module paths, generated artifacts, and release-facing build surfaces
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand All @@ -14,14 +14,14 @@ Use `karpathy-guidelines` alongside this skill for implementation or review
work. Keep changes scoped, surface assumptions, and define focused validation
before editing.

Use this skill when a change affects how NeMo Flow is built, packaged, named, or
Use this skill when a change affects how NeMo Relay is built, packaged, named, or
consumed outside the source tree.

## Audit Areas

- Rust `Cargo.toml` package names and workspace metadata
- Python packaging in `pyproject.toml`
- Go module path in `go/nemo_flow/go.mod`
- Go module path in `go/nemo_relay/go.mod`
- Node workspace metadata in root `package.json` and `package-lock.json`
- Node package metadata in `crates/node/package.json`
- WebAssembly package naming and generated package expectations
Expand All @@ -42,7 +42,7 @@ consumed outside the source tree.
## References

- `pyproject.toml`
- `go/nemo_flow/go.mod`
- `go/nemo_relay/go.mod`
- `package.json`
- `package-lock.json`
- `crates/node/package.json`
Expand Down
6 changes: 3 additions & 3 deletions .agents/skills/prepare-code-freeze/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
name: prepare-code-freeze
description: Prepare a NeMo Flow code freeze by creating the release branch, updating nightly alpha branch config, bumping main to the next version, and opening the required PR
description: Prepare a NeMo Relay code freeze by creating the release branch, updating nightly alpha branch config, bumping main to the next version, and opening the required PR
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---

# Prepare Code Freeze

Use this skill when the user asks to start, prepare, or automate a NeMo Flow
Use this skill when the user asks to start, prepare, or automate a NeMo Relay
code freeze.

## Companion Guidance
Expand All @@ -18,7 +18,7 @@ opening the PR.
## Workflow

This workflow assumes `upstream` is the NVIDIA repository remote
(`NVIDIA/NeMo-Flow`). The `origin` remote can be a maintainer's personal fork.
(`NVIDIA/NeMo-Relay`). The `origin` remote can be a maintainer's personal fork.
Comment thread
willkill07 marked this conversation as resolved.

1. Confirm or infer the target release version from `upstream/main:Cargo.toml`.
Derive the release branch as `release/<major>.<minor>`.
Expand Down
6 changes: 3 additions & 3 deletions .agents/skills/prepare-pr/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: prepare-pr
description: Prepare, open, create, publish, update, or edit a NeMo Flow pull request or PR body with the right tests, docs, contributor hygiene, and repository pull request template
description: Prepare, open, create, publish, update, or edit a NeMo Relay pull request or PR body with the right tests, docs, contributor hygiene, and repository pull request template
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---


# Prepare A PR For NeMo Flow
# Prepare A PR For NeMo Relay

## Companion Guidance

Expand All @@ -16,7 +16,7 @@ before editing.

Use this skill at the end of a contributor or maintainer change before opening a
pull request. Also use it whenever a user asks to create, open, publish, update,
or edit a NeMo Flow pull request, pull request description, or PR body.
or edit a NeMo Relay pull request, pull request description, or PR body.

If this repo-local guidance conflicts with generic GitHub publishing, connector,
or plugin guidance, this skill wins for PR body format, validation language, and
Expand Down
4 changes: 2 additions & 2 deletions .agents/skills/rename-surfaces/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: rename-surfaces
description: Perform a coordinated repository, package, crate, module, or symbol rename across NeMo Flow
description: Perform a coordinated repository, package, crate, module, or symbol rename across NeMo Relay
author: NVIDIA Corporation and Affiliates
license: Apache-2.0
---
Expand Down Expand Up @@ -34,7 +34,7 @@ or branding text updates that must preserve functional identifiers.
- Separate **branding text** from **functional identifiers**.
- Preserve repository and import paths exactly where code depends on them.
- Update generated or generated-from-build surfaces such as
`crates/ffi/nemo_flow.h` through the proper build step.
`crates/ffi/nemo_relay.h` through the proper build step.
- Search for old names after the rename and validate every public language
surface.

Expand Down
6 changes: 3 additions & 3 deletions .agents/skills/review-doc-style/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ before editing.

Use this skill when reviewing docs-only changes, example-heavy changes, or any
public-facing text update that should be checked against NVIDIA style guidance
and NeMo Flow repo conventions.
and NeMo Relay repo conventions.

## Review Priorities

- Prioritize factual accuracy over copy polish
- Flag stale commands, package names, APIs, bindings, repo paths, or support claims before stylistic issues
- Keep docs aligned with current NeMo Flow behavior, repo layout, and entry points
- Keep docs aligned with current NeMo Relay behavior, repo layout, and entry points
- Apply NVIDIA technical-writing guidance where it improves clarity and consistency without watering down technical precision

## Review Flow
Expand All @@ -33,7 +33,7 @@ and NeMo Flow repo conventions.
- `README.md`
- `docs/index.md`
- Package or crate READMEs
- Binding-level source READMEs such as `python/nemo_flow/README.md` or `crates/core/README.md`
- Binding-level source READMEs such as `python/nemo_relay/README.md` or `crates/core/README.md`
4. Start with `assets/nvidia-style-guide.md`, then open only the focused support document needed for the issue under review.
5. Scan for high-signal style issues in headings, links, code formatting, terminology, procedures, and plain-English readability.
6. Report findings in severity order with file references and concrete rewrites.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ SPDX-License-Identifier: Apache-2.0

# NVIDIA Style Guidance for Agents

Use this file as the first-pass reference for NeMo Flow documentation reviews.
Use this file as the first-pass reference for NeMo Relay documentation reviews.
It condenses NVIDIA writing guidance into review actions and points to focused
support documents for deeper checks.

This guide is not a substitute for verifying repository facts. For NeMo Flow
This guide is not a substitute for verifying repository facts. For NeMo Relay
docs, factual accuracy and current API behavior are more important than copy
polish.

Expand Down Expand Up @@ -85,7 +85,7 @@ available. Keep the finding body focused on the reader impact and the fix.
## Common Agent Pitfalls

- Do not enforce marketing or social-media rules on technical documentation.
- Do not add trademark symbols to NeMo Flow learning docs by default.
- Do not add trademark symbols to NeMo Relay learning docs by default.
- Do not replace precise technical terms with simpler words when precision would be lost.
- Do not flag passive voice when the actor is unknown or the action is the important part.
- Do not rewrite API names, package names, command flags, or code literals for style.
Expand Down
Loading
Loading