Repository navigation
docs(windows): document the Windows implementation and release branch - #4757
Conversation
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
🌿 Preview your docs: https://nvidia-preview-pr-4757.docs.buildwithfern.com/openshell |
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d855ff7490
ℹ️ 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".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
Summary
Supply the Windows documentation destinations referenced by merged PR #4758 and apply its resolved review feedback to the Windows branch. Keep platform entry points short, preserve the gateway example, and make the full-validation examples include MXC E2E and stop after every failed task.
Related Issue
Closes #4755.
#4758 is already merged into
main. Merge this PR intowindowsfirst, then #4646. The updated #4646 incorporates this branch; its remaining changes after this PR are six documentation files. Both PRs continue to targetwindows.The repository allows squash merges only. A three-way merge simulation against the current Windows base confirms that squashing this PR first and #4646 second is conflict-free and produces #4646's final tree. Auto-merge on #4646 is disabled to preserve this order.
The author has verified MAINTAIN access; #4755 has no
state:acceptedlabel.Changes
WINDOWS.mdwith the Windows checkout, four runtime binaries and matching Z3 DLL, Visual C++ runtime, MXC host requirements, and qualification limits.CI.md#windows-validationand the Windows testing guidance referenced frommain.$LASTEXITCODEimmediately after every task.Testing
mise run --skip-tools docspasses: navigation matches file paths; Fern 5.112.0 reports zero errors and two warnings for unauthenticated redirect checking and theme contrast.MxcComputeConfig, two detached JSON examples, and the immediate exit-code checks.git diff --checkand the documentation-only commit hook pass; all commits are DCO signed off.624f55b3c6affedd4f2757c7eb32132196b4c3e8.The PowerShell examples were checked on N1x-Test (native ARM64). Each shell parsed six blocks and ran 28 simulated success/failure cases for both architecture paths, including incomplete E2E coverage. These are documentation-example checks using mock task exits, not runtime qualification.
The link audit covered 49 occurrences and 23 distinct HTTP targets in #4758's additions and discussion. Currently,
windows/WINDOWS.mdreturns 404 andwindows/CI.md#windows-validationhas no matching heading. This PR supplies those destinations; the repository paths and fragments validate against its candidate tree. The runner-vetter help link redirects to corporate sign-in and could not be checked beyond that access gate.Full
mise run --skip-tools pre-commitwas attempted. Sandbox execution cannot start sccache; an unrestricted retry was stopped during dependency downloads after approximately eight minutes. A cached retry still lacksgrpcio==1.78.0anddeltae==0.3.2. The scoped checks above and documentation-only commit hook passed. No native OpenShell runtime/E2E qualification or full Rust/SDK CI result is claimed.Checklist