Repository navigation
docs(windows): route main documentation to the Windows release branch - #4758
shailendra-nv wants to merge 5 commits into
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-4758.docs.buildwithfern.com/openshell |
![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: c9142ea7d4
ℹ️ 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>
drew
left a comment
drew
left a comment
There was a problem hiding this comment.
Let's try and keep docs short and consistent.
| Native Windows has a separate implementation on the | ||
| [`windows` development and release branch](https://github.com/NVIDIA/OpenShell/tree/windows). | ||
| It pairs a host supervisor with an MXC ProcessContainer boundary. See the | ||
| [Windows architecture and limitations](https://github.com/NVIDIA/OpenShell/blob/windows/WINDOWS.md#runtime-and-current-limits) | ||
| before applying the guarantees below to that implementation. Exclusive | ||
| supervisor-mediated egress and live access revocation are not yet verified | ||
| for MXC. These Windows links remain on `windows` when this page is published | ||
| from `main`. |
There was a problem hiding this comment.
This doesn't belong at the top of the architecture page! Please remove.
There was a problem hiding this comment.
Removed the Windows paragraph above the diagram.
| Native Windows implementation and releases remain on the | ||
| [`windows` branch](https://github.com/NVIDIA/OpenShell/tree/windows). | ||
| Shared documentation can also publish from `main`. Link Windows-only source, | ||
| tasks, and runtime instructions explicitly to `blob/windows/` or `tree/windows/` | ||
| so those links remain valid from either branch. Do not describe `main` release | ||
| artifacts or `install.sh` as the native Windows distribution path. |
There was a problem hiding this comment.
Removed the Windows-specific paragraph.
Signed-off-by: Shailendra Singh <shailendras@nvidia.com>
|
Thanks for the feedback. The follow-up is pushed in 960d14ea. It trims the repeated Windows callouts, adds dedicated Windows sections, and restores the gateway example with current settings. The scoped documentation checks passed. The broad pre-commit task could not complete because Rust/Python dependency downloads are blocked in this environment; the documentation-only commit hook passed. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 960d14ea54
ℹ️ 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>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a11a8a2ec2
ℹ️ 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>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 14b86a1289
ℹ️ 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".
Summary
Direct readers of main's documentation to the maintained native Windows implementation on
windows. This PR is based on main and changes documentation only, keeping Windows implementation and releases on their own branch.Merge the companion Windows documentation PR #4757 first so links to its new
WINDOWS.mdresolve.Related Issue
Closes #4756.
Companion: #4757 targets
windowsand closes #4755. Related MXC implementation-detail documentation work is in #4646.The author has verified MAINTAIN access; the issue currently has no
state:acceptedlabel.Changes
windows, including from published docs on main.Release Notes
Native Windows documentation now identifies
windowsas its implementation and release branch and explains the current build and runtime limitations.Testing
git diff --checkpassed.mise run pre-commitwas attempted again but could not complete because Rust toolchain and Python/TypeScript dependency downloads were unavailable in this environment. Scoped contributor-guidance checks passed, including all 20 immediate exit-code checks. A temporary documentation-only commit hook passed; the installed repository hook was unchanged.Checklist