Skip to content

docs(windows): document the Windows implementation and release branch - #4757

Open
shailendra-nv wants to merge 1 commit into
windowsfrom
docs/4755-windows-branch-guidance/shailendra-nv
Open

shailendra-nv wants to merge 1 commit into
windowsfrom
docs/4755-windows-branch-guidance/shailendra-nv

Conversation

@shailendra-nv

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

Copy link
Copy Markdown
Collaborator

Summary

Native Windows readers currently encounter WSL-only quickstart guidance and inconsistent checkout instructions. Add a Windows entry guide and update the root technical docs so windows remains the native Windows implementation and release branch, including when shared documentation is later published on main.

Related Issue

Closes #4755.

Related: #4646 covers additional MXC implementation-detail documentation corrections; this PR focuses on top-level discovery and the branch placement rule. Companion PR #4758 targets main and closes #4756; merge this Windows PR first so its new guide exists before main links to it.

The author has verified MAINTAIN access; the issue currently has no state:accepted label.

Changes

  • Add WINDOWS.md with native x64/ARM64 checkout, builds, runtime prerequisites, four executables plus matching Z3 DLL, and validation guidance.
  • Update README, contributor/testing/CI/security/style/agent guidance and published platform entry points to direct Windows work to windows.
  • Preserve current MXC qualification limits and distinguish native Windows from WSL and main release artifacts.
  • Correct socket-owner policy wording and the MXC example's missing --detach; align the Windows contributor skill with the release branch.
  • Change documentation only. No runtime, build-script, workflow, or policy-fixture implementation changes.

Testing

  • Markdown lint: 157 files, zero errors; repeated by the commit hook.
  • Documentation navigation checker: every page URL matches its path.
  • Fern 5.112.0 validation: zero errors; existing warnings for unauthenticated redirect checking and theme contrast.
  • Repository link/anchor review and git diff --check.
  • Broad mise run --skip-tools pre-commit was attempted but could not complete because sandbox network restrictions blocked Rust/Python dependency downloads. A temporary Markdown-only commit hook passed; the repository's installed hook was not changed.
  • Runtime unit/E2E tests are not applicable to these documentation-only changes. Documented Windows commands were checked against the branch's task definitions and implementation, not executed as runtime qualification.

Checklist

  • Follows Conventional Commits.
  • Commits are signed off (DCO).
  • Relevant architecture and published documentation updated.

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

copy-pr-bot Bot commented Oct 20, 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 20, 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-20T17:32:49.699312Z 353e3e7 PR opened
🔒 Security Review ✅ Completed 2026-10-20T17:33:43.141093Z 353e3e7 PR opened
ℹ️ 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

This branch has not been deployed

No deployments
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.

1 participant