Skip to content

docs(windows): align MXC documentation with the implementation - #4646

Merged
shailendra-nv merged 8 commits into
windowsfrom
docs/4645-windows-documentation/shailendra-nv
Oct 28, 2026
Merged

shailendra-nv merged 8 commits into
windowsfrom
docs/4645-windows-documentation/shailendra-nv

Conversation

@shailendra-nv

@shailendra-nv shailendra-nv commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Finish the MXC documentation corrections after #4757 supplies the shared Windows guide, reviewed platform entry points, and published ETW audit warning. Correct the test reference, policy/runtime limitations, RFC runtime binary names, and CLI policy-update guidance without changing the implementation.

Related Issue

Closes #4645.

Depends on #4757. #4758 is already merged into main; merge #4757 into windows first to restore its missing guide and CI-heading links, then merge this PR. This branch incorporates the updated #4757 commits so the shared edits are consistent. After #4757 is merged, this PR's remaining diff is six Markdown/MDX files.

The repository permits squash merges only. The proposed squash order was simulated against the current Windows base and is conflict-free; the result matches this branch's final tree. Auto-merge on this PR is disabled until its prerequisite lands. Related roadmap issue #4450 remains open.

Changes

Testing

Shared PowerShell validation ran on N1x-Test (native ARM64), covering six syntax checks and 28 simulated task-exit cases per shell, including both architecture paths and incomplete E2E coverage. This is 68 test executions shared with #4757, not another 68 executions or native MXC qualification.

Suite Total Passed Skipped/ignored Failed Result
Windows PowerShell 5.1 34 34 0 0 PASS
PowerShell 7.6.6 34 34 0 0 PASS
All test executions 68 68 0 0 PASS

Full pre-commit was attempted but did not complete dependency setup. The sandbox cannot start sccache; the unrestricted dependency-download retry was stopped, and a cached retry still lacks grpcio==1.78.0 and deltae==0.3.2. Scoped documentation checks and the documentation-only commit hook passed. No full Rust/SDK CI or native OpenShell runtime/E2E qualification result is claimed.

Checklist

Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Oct 16, 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.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-27T23:52:10.817599Z adaf82f New commits
🔒 Security Review ✅ Completed 2026-10-27T23:52:57.843882Z adaf82f New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

Copy link
Copy Markdown

@shailendra-nv

Copy link
Copy Markdown
Collaborator Author

/ok to test

@copy-pr-bot

copy-pr-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

/ok to test

@shailendra-nv, there was an error processing your request: E1

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/

@shailendra-nv
shailendra-nv requested a review from drew October 20, 2026 16:28
@shailendra-nv
shailendra-nv enabled auto-merge (squash) October 20, 2026 16:28
@shailendra-nv

Copy link
Copy Markdown
Collaborator Author

@drew Review requested for this documentation-only PR. The source-consistency review of commit 3eb4b7e found no actionable issues; the PR head and Windows base are unchanged since that review. Documentation preview and DCO checks pass.

Pre-merge validation is blocked: copy-pr-bot rejected my /ok to test request with E1, and no pull-request/4646 workflow runs have started. Please review and help obtain validation from an authorized PR vetter. The E1 documentation requires corporate sign-in, so I have not verified its specific cause.

Squash auto-merge is enabled, subject to the required approval and checks. Native runtime/E2E tests were not rerun as part of this documentation review.

Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
@shailendra-nv
shailendra-nv merged commit 5d1bfbf into windows Oct 28, 2026
15 of 18 checks passed
@shailendra-nv
shailendra-nv deleted the docs/4645-windows-documentation/shailendra-nv branch October 28, 2026 00:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants