docs(e2e): reconcile scenario migration docs by cv · Pull Request #4654 · NVIDIA/NemoClaw

cv · 2026-06-02T07:34:21Z

Summary

Reconciles the E2E scenario README and migration notes with the current hybrid framework. This removes the stale local migration checklist and points mutable migration tracking to the active GitHub issues.

Related Issue

Refs #3588.

Changes

Rewrite test/e2e-scenario/docs/README.md around the current typed/YAML/manifest/legacy hybrid model.
Replace the stale test/e2e-scenario/docs/MIGRATION.md script checklist with issue-based migration guidance.
Document current scenario commands, CI entry points, and cleanup rules.

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)

Verification

npx prek run --all-files passes
npm test passes
Tests added or updated for new or changed behavior
No secrets, API keys, or credentials committed
Docs updated for user-facing behavior changes
npm run docs builds without warnings (doc changes only)
Doc pages follow the style guide (doc changes only)
New doc pages include SPDX header and frontmatter (new pages only)

Additional verification run: npx prek run --files test/e2e-scenario/docs/README.md test/e2e-scenario/docs/MIGRATION.md.

Signed-off-by: Carlos Villela cvillela@nvidia.com

Summary by CodeRabbit

Documentation
- Reworked E2E scenario framework docs to describe a hybrid migration model and clarify sources of truth.
- Added migration roadmap, active-issue mapping, contributor workflow steps, and concrete runner/coverage guidance.
- Clarified repository layout and CI entry points, preserved legacy test coverage until audit reconciliation, and defined cleanup rules.

copy-pr-bot · 2026-06-02T07:34:25Z

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

coderabbitai · 2026-06-02T07:34:29Z

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: 8d0e49f8-c94d-4851-89b3-b1168acb9dbe

📥 Commits

Reviewing files that changed from the base of the PR and between 378b489 and 1bbce3f.

📒 Files selected for processing (2)

test/e2e-scenario/docs/MIGRATION.md
test/e2e-scenario/docs/README.md

✅ Files skipped from review due to trivial changes (1)

test/e2e-scenario/docs/README.md

🚧 Files skipped from review as they are similar to previous changes (1)

test/e2e-scenario/docs/MIGRATION.md

📝 Walkthrough

Walkthrough

The PR rewrites two documentation files to establish a cohesive narrative of the NemoClaw E2E scenario framework's hybrid migration model, replacing legacy strategy tracking with concrete issue references, clarified execution paths, and contributor workflow guidance.

Changes

E2E Scenario Framework Documentation Rewrite

Layer / File(s)	Summary
Migration State and Cleanup Guidance `test/e2e-scenario/docs/MIGRATION.md`	Hybrid E2E migration state description, active GitHub issue tracking table, contributor "what to migrate next" checklist, useful commands for scenario runner and coverage reporting, and cleanup rules restricting legacy script removal.
Framework Documentation and Execution Guide `test/e2e-scenario/docs/README.md`	Hybrid migration model introduction, sources-of-truth table, expanded scenario layering explanation, typed registry execution commands (`tsx ... --list/--emit-matrix`), updated repository layout, CI entry points, and migration tracking that references GitHub issues instead of mutable repo state.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

NVIDIA/NemoClaw#4649: Both PRs rewrite test/e2e-scenario/docs/MIGRATION.md and test/e2e-scenario/docs/README.md to shift E2E migration tracking to GitHub issues/PRs and remove repo-local mutable migration state.

Suggested labels

v0.0.58

Suggested reviewers

prekshivyas
cjagwani

Poem

🐰 Hops through migration maps with glee,
GitHub issues now the source we see,
No more dusty docs that shift and sway—
Just facts and workflows, clear as day!
Clean rules for cleanup, commands to guide,
The hybrid path laid long and wide. 🎯

🚥 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 'docs(e2e): reconcile scenario migration docs' directly and clearly summarizes the main change—reconciling E2E scenario documentation with the hybrid migration model.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/e2e-scenario-hybrid-reconciliation

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

github-actions · 2026-06-02T07:35:11Z

E2E Advisor Recommendation

Required E2E: None
Optional E2E: None

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

None. Documentation-only changes to E2E scenario guides and migration notes cannot affect NemoClaw runtime behavior or real user flows. No existing E2E job is needed for merge confidence.

Optional E2E

None.

New E2E recommendations

None.

github-actions · 2026-06-02T07:35:12Z

E2E Scenario Advisor Recommendation

Required scenario E2E: None
Optional scenario E2E: None

Workflow run

Full scenario advisor summary

E2E Scenario Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required scenario E2E

None. Docs-only changes under test/e2e-scenario/docs; no scenario runtime, workflow, metadata, expected-state, suite catalog, helper, or suite execution behavior is affected.

Optional scenario E2E

None.

Relevant changed files

test/e2e-scenario/docs/MIGRATION.md
test/e2e-scenario/docs/README.md

github-actions · 2026-06-02T07:36:52Z

PR Review Advisor

Findings: 0 needs attention, 1 worth checking, 0 nice ideas
Top item: PR review advisor unavailable

Review findings

🛠️ Needs attention

None.

🔎 Worth checking

PR review advisor unavailable: The automated advisor could not complete: Could not parse JSON from PR review advisor output; see /home/runner/work/NemoClaw/NemoClaw/artifacts/pr-review-advisor/pr-review-advisor-raw-output.txt
- Recommendation: Re-run the PR Review Advisor or perform a manual review.
- Evidence: Could not parse JSON from PR review advisor output; see /home/runner/work/NemoClaw/NemoClaw/artifacts/pr-review-advisor/pr-review-advisor-raw-output.txt

🌱 Nice ideas

None.

Workflow run details

This is an automated advisory review. A human maintainer must make the final merge decision.

wscurran · 2026-06-03T18:10:01Z

✨
Related open issues:

#3588 Implement layered E2E scenario model

cv added 2 commits June 1, 2026 23:42

test(e2e): add scenario aliases for layered plans

dbc672f

docs(e2e): reconcile scenario migration docs

c66d2a3

cv self-assigned this Jun 2, 2026

Base automatically changed from test/e2e-scenario-friendly-aliases to main June 3, 2026 17:50

wscurran added area: docs Documentation, examples, guides, or docs build area: e2e End-to-end tests, nightly failures, or validation infrastructure labels Jun 3, 2026

merge: main into docs e2e scenario reconciliation

378b489

cv marked this pull request as ready for review June 3, 2026 18:29

docs(e2e): align migration tracking wording

1bbce3f

cv added the v0.0.59 label Jun 4, 2026

cv merged commit ac3c5ae into main Jun 4, 2026
31 checks passed

cv deleted the docs/e2e-scenario-hybrid-reconciliation branch June 4, 2026 19:46

This was referenced Jun 8, 2026

docs(e2e): clarify single-runner scenario target #4939

Merged

test(e2e): execute real shell assertions; delete dry-run, --validate-only, and the bash runner #4380

Merged

docs(e2e): choose Vitest fixtures as scenario runner #4963

Merged

wscurran added the chore Build, CI, dependency, or tooling maintenance label Jun 8, 2026

This was referenced Jun 9, 2026

chore(e2e): refresh docs and add real gateway negative-path test #5042

Merged

test(e2e): extend migration inventory to scenario runner internals #5052

Merged

Uh oh!

Conversation

cv commented Jun 2, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related Issue

Changes

Type of Change

Verification

Summary by CodeRabbit

Uh oh!

copy-pr-bot Bot commented Jun 2, 2026

Uh oh!

coderabbitai Bot commented Jun 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Uh oh!

github-actions Bot commented Jun 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

E2E Advisor Recommendation

E2E Recommendation Advisor

Required E2E

Optional E2E

New E2E recommendations

Uh oh!

github-actions Bot commented Jun 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

E2E Scenario Advisor Recommendation

E2E Scenario Advisor

Required scenario E2E

Optional scenario E2E

Relevant changed files

Uh oh!

github-actions Bot commented Jun 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review Advisor

🛠️ Needs attention

🔎 Worth checking

🌱 Nice ideas

Uh oh!

wscurran commented Jun 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cv commented Jun 2, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 2, 2026 •

edited

Loading

github-actions Bot commented Jun 2, 2026 •

edited

Loading

github-actions Bot commented Jun 2, 2026 •

edited

Loading

github-actions Bot commented Jun 2, 2026 •

edited

Loading