[docs] Update landing readme.md by jsidewhite · Pull Request #1437 · microsoft/mxc

Jeff Whiteside (jsidewhite) · 2026-10-07T04:42:53Z

[docs] Update landing readme.md

Microsoft Reviewers: Open in CodeFlow

azure-pipelines · 2026-10-07T04:43:01Z

Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run.

Copilot

Copilot review overview

🟡 Changes recommended

Streaming correctness, platform requirements, and broken documentation anchors need correction.

Review effort: Balanced
Findings: 2 · 5

Open (7)

Await output streams before disposing the process · New
Handle Writable backpressure to prevent unbounded buffering · New
Preserve the legacy platforms anchor · New
Correctly restrict Hyperlight to x86_64 · New
Document Seatbelt's macOS 15 minimum requirement · New
Preserve the audit mode permissive learning mode anchor · New
Document the .NET SDK 10+ prerequisite · New

What changed in this PR

Refreshes the consumer landing page and reorganizes contributor guidance.

Changes:

Reworks the landing README around SDK consumption and platform support.
Adds a local-development guide.
Updates the Node streaming sample to demonstrate event callbacks.

File	Description
`README.md`	Reorganizes consumer documentation and examples.
`docs/development/README.md`	Links new development resources.
`docs/development/build-and-test/local-development.md`	Adds local build and validation commands.
`samples/run-with-io-stdio-streaming/README.md`	Documents Node stream callbacks.
`samples/run-with-io-stdio-streaming/node/src/main.ts`	Uses event-driven output forwarding.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

+    );
  }
+  return new Promise<void>((resolve, reject) => {
+    stream.on('data', (chunk) => destination.write(chunk));


+the resulting container.

-For which filesystem, network, and UI-restriction policy aspects the Windows `processcontainer` backend can enforce on each Windows 11 release (23H2 / 24H2 / 25H2 / 25H2+), see [Windows OS-version policy support](./docs/backends/process-container/os-version-support.md).
+### What container types are supported?


+| Windows 11 x64 / ARM64 | `processcontainer` | `windows_sandbox`, `wslc`, `microvm`, `hyperlight`, `isolation_session` | `processcontainer`: 26100 (24H2)<br>`isolation_session`: 26340.9212 ([Insider Preview](https://learn.microsoft.com/en-us/windows-insider/release-notes/experimental/preview-build-26340-9212)) |
+| Linux x64 / ARM64 | `bubblewrap` | `lxc`, `microvm`, `hyperlight` | - |


+|---|---|---|---|
+| Windows 11 x64 / ARM64 | `processcontainer` | `windows_sandbox`, `wslc`, `microvm`, `hyperlight`, `isolation_session` | `processcontainer`: 26100 (24H2)<br>`isolation_session`: 26340.9212 ([Insider Preview](https://learn.microsoft.com/en-us/windows-insider/release-notes/experimental/preview-build-26340-9212)) |
+| Linux x64 / ARM64 | `bubblewrap` | `lxc`, `microvm`, `hyperlight` | - |
+| macOS ARM64 / x64 | `seatbelt` | - | - |


+developer reference.

-### Request-aware ProcessContainer probe
+### Audit mode


Anis Mohammed Khaja Mohideen (kanismohammed) · 2026-10-07T04:47:11Z


-MXC is a **sandboxed code execution system** for running untrusted code (model output, plugins, tools) on Windows, Linux, and macOS. It provides multiple containment backends — from OS-native process sandboxes to full VMs — behind a unified JSON configuration schema and TypeScript SDK.
+MXC is a **sandboxed code execution system** for running untrusted code
+(agentic actions, plugins, and tools) on Windows, Linux, and macOS. It provides


agentic actions

leave it as model output

Branden Bonaby (bbonaby) · 2026-10-07T04:47:32Z

+# Local development
+
+> **Audience:** MXC developers
+
+Use the repository build scripts for complete platform builds. The commands
+below target individual components or validation steps during development.
+Run Rust commands from `src/`.
+
+## Component builds
+
+```text
+# Windows x64
+cargo build --release --target x86_64-pc-windows-msvc
+
+# Windows ARM64
+cargo build --release --target aarch64-pc-windows-msvc
+
+# Linux executor for the LXC and Bubblewrap backends
+cargo build --release -p lxc
+
+# macOS executor
+cargo build --release -p mxc_darwin --target aarch64-apple-darwin
+```
+
+Build the Node SDK from `sdk/node/`:
+
+```text
+npm install
+npm run build
+```
+
+## Format and lint
+


note: for this file, we probably should just tell the developers to run the build.bat on windows, build.sh on linux and build-mac.sh on macOS. The .bat should build the crates, nuget package and npm package.

Branden Bonaby (bbonaby) · 2026-10-07T04:49:19Z

+    SDK --> Engine["MXC engine<br/>(in process)"]
+    Engine --> Backend["Selected backend<br/>(in process)"]


note: probably can just go from SDK -> Backend tbh

Anis Mohammed Khaja Mohideen (kanismohammed) · 2026-10-07T04:56:00Z

-### Requirements
+| Runtime platform | Default backend | Other backends | Minimum host OS |
+|---|---|---|---|
+| Windows 11 x64 / ARM64 | `processcontainer` | `windows_sandbox`, `wslc`, `microvm`, `hyperlight`, `isolation_session` | `processcontainer`: 26100 (24H2)<br>`isolation_session`: 26340.9212 ([Insider Preview](https://learn.microsoft.com/en-us/windows-insider/release-notes/experimental/preview-build-26340-9212)) |


26340.9212

PRovide the link to the Windows OS Support

Copilot

Note

Copilot was unable to run its full agentic suite in this review.

Copilot review overview

Review effort: Lite
Findings: 1 · 3 · 7

Open (11)

This new event-based forwarding drops backpressure handling: destination.write(chunk) can return… · New
The comment contradicts the flag name: --all typically implies building multiple… · New
Handle Writable backpressure to prevent unbounded buffering
Await output streams before disposing the process
The capitalization of 'Nanvix' appears inconsistent with earlier references to 'NanVix' in this… · New
Inside an async function, returning Promise.reject(...) is redundant and slightly harder to… · New
Document the .NET SDK 10+ prerequisite
Preserve the audit mode permissive learning mode anchor
Document Seatbelt's macOS 15 minimum requirement
Correctly restrict Hyperlight to x86_64
Preserve the legacy platforms anchor

+  return new Promise<void>((resolve, reject) => {
+    stream.on('data', (chunk) => destination.write(chunk));
+    stream.once('end', resolve);
+    stream.once('error', reject);
+  });


-Telemetry is **off by default**. To keep it off, do not set
-`"telemetry": { "enabled": true }` for the run.
+#### Windows
+


+    return Promise.reject(
+      new Error('The selected backend did not provide an expected output stream.'),


Copilot

Copilot review overview

🟡 Changes recommended

Several build instructions are inaccurate, and the Node examples mishandle process ownership or stream backpressure.

Review effort: Balanced
Findings: 1 · 2 · 6

Open (9)

This new event-based forwarding drops backpressure handling: destination.write(chunk) can return…
The comment contradicts the flag name: --all typically implies building multiple…
Handle Writable backpressure to prevent unbounded buffering
Remove unsupported --all option from Linux build · New
Inside an async function, returning Promise.reject(...) is redundant and slightly harder to…
Preserve the audit mode permissive learning mode anchor
Document Seatbelt's macOS 15 minimum requirement
Correctly restrict Hyperlight to x86_64
Preserve the legacy platforms anchor

Resolved since last review (3)

Await output streams before disposing the process
The capitalization of 'Nanvix' appears inconsistent with earlier references to 'NanVix' in this…
Document the .NET SDK 10+ prerequisite

Previously missed (3)

In code that hasn't changed since last review

Mark Linux microvm and hyperlight as experimental

README.md:55

The footnote only applies to starred entries, but the Linux microvm and hyperlight backends are experimental too (the previous README and their backend guides require experimental authorization). Leaving them unstarred makes the support table present them as non-experimental on Linux.

Complete MxcProcess lifecycle in landing example

README.md:96

The landing example returns an owning MxcProcess but never calls wait() or dispose(). wait() is also what drains untaken output, so copying this pattern for a noisier command can block on full stdio pipes. For this minimal example, use run() (or show the complete stream/wait/dispose lifecycle).

Correct Windows Node.js version prerequisite

README.md:161

This prerequisite is too broad on Windows: native stdio rejects Node 24 before 24.21.0 and all Node 25 releases; support resumes at 26.8.0. Retain the platform-specific requirement documented in sdk/node/README.md:15-17.


-Official/shipped Microsoft builds set a TraceLogging provider group GUID at build time and route `MXC.Execution`, `MXC.Error`, and `MXC.VerboseDenials` events to Microsoft through the UTC pipeline when telemetry is enabled — that same build-time setting also selects the correct Measures keyword and Product-and-Service-Usage privacy tag for the events, so telemetry routing and event classification always agree. **Local and open-source builds send nothing to Microsoft by default** — the public source ships without a provider group GUID, so events are emitted to the local ETW subsystem only, use a provider-local keyword with no UTC meaning, and carry no privacy classification tag, and are not routed to any Microsoft collection pipeline. Internal builds that set the `MXC_TELEMETRY_PROVIDER_GROUP_GUID` environment variable at build time enable the Microsoft-routed path.
+```bash
+./build.sh --all            # Release build


[docs] Update landing readme.md

8e1a68c

Copilot AI balanced review requested due to automatic review settings October 7, 2026 04:42

Jeff Whiteside (jsidewhite) requested a review from a team as a code owner October 7, 2026 04:42

Copilot started reviewing on behalf of Jeff Whiteside (jsidewhite) October 7, 2026 04:43 View session

Copilot AI reviewed Oct 7, 2026

View reviewed changes

Anis Mohammed Khaja Mohideen (kanismohammed) reviewed Oct 7, 2026

View reviewed changes

Branden Bonaby (bbonaby) reviewed Oct 7, 2026

View reviewed changes

Anis Mohammed Khaja Mohideen (kanismohammed) reviewed Oct 7, 2026

View reviewed changes

DOCUMENTATION 3 - rewrites

aedd9ec

Copilot AI balanced review requested due to automatic review settings October 7, 2026 05:23

DOCUMENTATION 3 - rewrites

226e7cd

Copilot started reviewing on behalf of Jeff Whiteside (jsidewhite) October 7, 2026 05:24 View session

Jeff Whiteside (jsidewhite) added 5 commits October 6, 2026 22:26

DOCUMENTATION 3 - rewrites

7a0716f

DOCUMENTATION 3 - rewrites

d840778

DOCUMENTATION 3 - rewrites

42e1e77

DOCUMENTATION 3 - rewrites

ef09980

DOCUMENTATION 3 - rewrites

7c85984

Anis Mohammed Khaja Mohideen (kanismohammed) approved these changes Oct 7, 2026

View reviewed changes

Copilot stopped reviewing on behalf of Jeff Whiteside (jsidewhite) due to an error October 7, 2026 05:49
Copilot had to stop work due to a timeout.

Copilot AI reviewed Oct 7, 2026

View reviewed changes

Copilot AI balanced review requested due to automatic review settings October 7, 2026 05:50

Copilot started reviewing on behalf of Jeff Whiteside (jsidewhite) October 7, 2026 05:50 View session

Copilot AI reviewed Oct 7, 2026

View reviewed changes

Anis Mohammed Khaja Mohideen (kanismohammed) merged commit c645d02 into main Oct 7, 2026
31 checks passed

Anis Mohammed Khaja Mohideen (kanismohammed) deleted the jsidewhite/docs_3_rewrite branch October 7, 2026 05:58

Navigation Menu

Repository navigation

[docs] Update landing readme.md - #1437

[docs] Update landing readme.md#1437
Anis Mohammed Khaja Mohideen (kanismohammed) merged 8 commits into
mainfrom
jsidewhite/docs_3_rewrite

Jeff Whiteside (jsidewhite) commented Oct 7, 2026 •

edited by microsoft-github-policy-service Bot

Loading

Uh oh!

azure-pipelines Bot commented Oct 7, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Anis Mohammed Khaja Mohideen (kanismohammed) Oct 7, 2026

Uh oh!

Branden Bonaby (bbonaby) Oct 7, 2026

Uh oh!

Branden Bonaby (bbonaby) Oct 7, 2026

Uh oh!

Anis Mohammed Khaja Mohideen (kanismohammed) Oct 7, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		\| Windows 11 x64 / ARM64 \| `processcontainer` \| `windows_sandbox`, `wslc`, `microvm`, `hyperlight`, `isolation_session` \| `processcontainer`: 26100 (24H2)<br>`isolation_session`: 26340.9212 ([Insider Preview](https://learn.microsoft.com/en-us/windows-insider/release-notes/experimental/preview-build-26340-9212)) \|
		\| Linux x64 / ARM64 \| `bubblewrap` \| `lxc`, `microvm`, `hyperlight` \| - \|

		SDK --> Engine["MXC engine<br/>(in process)"]
		Engine --> Backend["Selected backend<br/>(in process)"]

		return Promise.reject(
		new Error('The selected backend did not provide an expected output stream.'),

Conversation

Jeff Whiteside (jsidewhite) commented Oct 7, 2026 • edited by microsoft-github-policy-service Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Microsoft Reviewers: Open in CodeFlow

Uh oh!

azure-pipelines Bot commented Oct 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Anis Mohammed Khaja Mohideen (kanismohammed) Oct 7, 2026

Choose a reason for hiding this comment

Uh oh!

Branden Bonaby (bbonaby) Oct 7, 2026

Choose a reason for hiding this comment

Uh oh!

Branden Bonaby (bbonaby) Oct 7, 2026

Choose a reason for hiding this comment

Uh oh!

Anis Mohammed Khaja Mohideen (kanismohammed) Oct 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Jeff Whiteside (jsidewhite) commented Oct 7, 2026 •

edited by microsoft-github-policy-service Bot

Loading