docs: describe trajectory-context trusted metadata

[bbednarski9]

Overview

Documents the trajectory_context trusted Scope-metadata contract implemented by #531 for NeMo Relay 0.6. Merge this documentation PR after #531 so the public guidance and release branch stay aligned.

• I confirm this contribution is my own work, or I have the right to submit it under this project's license.
• I searched existing issues and open pull requests, and this does not duplicate existing work.

Details

• Removes the obsolete known-issue claim that trajectory_context redacts Relay's structural classification metadata.
• Lists the direct string and boolean Scope metadata fields retained by the preset and explains that unexpected types, nested values, and unlisted fields remain subject to semantic redaction.
• Clarifies that custom_mark_payload_policy controls unknown custom Mark payloads, not Scope metadata.
• Documents nemo_relay.agent.kind as the canonical OpenTelemetry and OpenInference root-span attribute for harness classification.
• Adds matching release-migration guidance and warns against placing PII or conversational content in retained classification fields.
• Makes no runtime, configuration-schema, or breaking behavior changes.

Validation:

• Generated the Python, Node.js, and Rust API-reference pages used by the Fern checks.
• Fern configuration validation passed with zero errors and one expected unauthenticated-redirect warning.
• Fern strict broken-link validation passed.
• Focused pre-commit checks passed for both changed files.
• just docs could not run because just is not installed in the environment; the equivalent generators and Fern validation commands completed successfully.

Where should the reviewer start?

Start with the new trusted-metadata contract in docs/configure-plugins/pii-redaction/configuration.mdx, then confirm the matching release-migration note in docs/about-nemo-relay/release-notes/known-issues.mdx.

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

• Relates to [Bug]: trajectory_context redacts structural scope metadata #528
• Relates to fix(pii): preserve trusted scope metadata #531 (merge after fix(pii): preserve trusted scope metadata #531)

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 6d2966c3-d187-484d-ab96-1acb47b52c4b

📥 Commits

Reviewing files that changed from the base of the PR and between 239a423 and 106a5dc.

📒 Files selected for processing (2)

• docs/about-nemo-relay/release-notes/known-issues.mdx
• docs/configure-plugins/pii-redaction/configuration.mdx

📜 Recent review details

⏰ Context from checks skipped due to timeout. (2)

• GitHub Check: Check / Run
• GitHub Check: Preview docs

🧰 Additional context used

📓 Path-based instructions (9)

**/*.mdx

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)

In MDX files, top-of-file comments must use JSX comment delimiters ({/* to open and */} to close); do not use HTML comments for MDX SPDX headers

Files:

• docs/configure-plugins/pii-redaction/configuration.mdx
• docs/about-nemo-relay/release-notes/known-issues.mdx

**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Update README.md, fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.

**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Keep stable user-facing wrappers at scripts/ root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, and grpc-v1 protocol details on separate pages

If links in documentation change, run just docs-linkcheck.

Files:

• docs/configure-plugins/pii-redaction/configuration.mdx
• docs/about-nemo-relay/release-notes/known-issues.mdx

**/*.{md,markdown,mdx}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.

Files:

• docs/configure-plugins/pii-redaction/configuration.mdx
• docs/about-nemo-relay/release-notes/known-issues.mdx

{docs,examples}/**/*

📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)

Update docs and examples.

Files:

• docs/configure-plugins/pii-redaction/configuration.mdx
• docs/about-nemo-relay/release-notes/known-issues.mdx

**/*

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, use maintain-dynamic-plugins and include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, prefer uv run pre-commit run --files <changed files...>.
Before review or handoff, run uv run pre-commit run --all-files.

Files:

• docs/configure-plugins/pii-redaction/configuration.mdx
• docs/about-nemo-relay/release-notes/known-issues.mdx

docs/**/*

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

If documentation examples or commands under docs/ change, run the targeted docs checks appropriate to the change.

Files:

• docs/configure-plugins/pii-redaction/configuration.mdx
• docs/about-nemo-relay/release-notes/known-issues.mdx

{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}

⚙️ CodeRabbit configuration file

{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.

Files:

• docs/configure-plugins/pii-redaction/configuration.mdx
• docs/about-nemo-relay/release-notes/known-issues.mdx

docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx

📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)

docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx: Update only docs/about-nemo-relay/release-notes/index.mdx, docs/about-nemo-relay/release-notes/highlights.mdx, and docs/about-nemo-relay/release-notes/known-issues.mdx unless the release changes their route or entry points.
Preserve the existing MDX front matter and the JSX SPDX comment in the release-notes pages.

Files:

• docs/about-nemo-relay/release-notes/known-issues.mdx

docs/about-nemo-relay/release-notes/known-issues.mdx

📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)

docs/about-nemo-relay/release-notes/known-issues.mdx: In known-issues.mdx, preserve every prior fixed-item bullet under release-labeled subsections; do not summarize, deduplicate, or omit it.
In known-issues.mdx, keep the complete fixed-item history recorded in earlier release-note pages.

Files:

• docs/about-nemo-relay/release-notes/known-issues.mdx

🔇 Additional comments (1)

docs/about-nemo-relay/release-notes/known-issues.mdx (1)

67-67: 📐 Maintainability & Code Quality

Run just docs-linkcheck for the newly added issue links.

• docs/about-nemo-relay/release-notes/known-issues.mdx#L67-L67: validate the GitHub issue link.
• docs/configure-plugins/pii-redaction/configuration.mdx#L186-L186: validate the GitHub issue link.

Source: Path instructions

---

Walkthrough

Documents trajectory_context limitations affecting generic scope metadata, clarifies custom_mark_payload_policy scope, and references issue #528 regarding profile-array configuration constraints.

Changes

PII redaction documentation

Layer / File(s)	Summary
Document sanitization limitations docs/about-nemo-relay/release-notes/known-issues.mdx, docs/configure-plugins/pii-redaction/configuration.mdx	Documents affected generic scope classification fields, unchanged event keys and topology, custom_mark_payload_policy behavior, and profile-array limitations when enabling LLM and tool sanitization.

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

Possibly related issues

• [Bug]: trajectory_context redacts structural scope metadata #528 — The documentation directly describes the sanitizer behavior and configuration limitations tracked by this issue.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title follows Conventional Commits, is under 72 characters, and accurately summarizes the docs-only change.
Description check	✅ Passed	The description includes the required overview, details, reviewer start point, checklist items, validation, and related issues.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/pii-trajectory-context-known-issue

---

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

[github-actions]

Fern docs preview: https://nvidia-preview-pull-request-529.docs.buildwithfern.com/nemo/relay/dev

[bbednarski9]

not ready, need to update after #531 lands

[willkill07]

Closing in favor of #531