Samuel100/update readmes by samuel100 · Pull Request #573 · microsoft/Foundry-Local

samuel100 · 2026-04-01T17:09:26Z

Update README to better align the product offering.

Updated sample READMEs.

- Rewrite root README: SDK quickstart first, CLI section minimized, E2E solution messaging, links to MS Learn docs - Create samples/README.md: top-level overview of all sample languages - Create samples/js/README.md: list all 12 JS samples with run instructions - Create samples/python/README.md: list all 9 Python samples with run instructions - Update samples/cs/README.md: add missing LiveAudioTranscription samples - Update samples/rust/README.md: add 4 tutorial samples, table format Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

vercel · 2026-04-01T17:09:32Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
foundry-local	Ready	Preview, Comment	Apr 1, 2026 5:09pm

Copilot

Pull request overview

Updates and standardizes README documentation to better match the current Foundry Local product positioning, and adds/refreshes language-specific sample indexes and run instructions.

Changes:

Reworks the root README.md messaging, quickstarts, and CLI section to align with the “ship on-device AI” narrative.
Adds new README entrypoints for Python and JavaScript samples and refreshes Rust/C# sample listings.
Introduces a samples/README.md hub that links to language sample directories and summarizes coverage.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
README.md	Updates product overview, quickstarts, samples table, CLI info, and FAQs to align with current offering.
samples/README.md	Adds a language-indexed samples hub README.
samples/cs/README.md	Expands the C# sample list and trims some running guidance text.
samples/js/README.md	Adds a JavaScript samples index and “running a sample” instructions.
samples/python/README.md	Adds a Python samples index and “running a sample” instructions.
samples/rust/README.md	Refreshes Rust samples listing and adds “running a sample” plus a Windows WinML note.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-01T17:16:22Z

samples/python/README.md

+   If you developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:
+
+   ```bash
+   cd native-chat-completions
+   pip install foundry-local-sdk-winl


The Windows install command uses foundry-local-sdk-winl, but elsewhere in this repo (README.md) the package name is foundry-local-sdk-winml. This inconsistency is likely a typo and will cause the documented command to fail. Please align the package name across docs (and verify the published package name).

Suggested change

If you developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:

```bash

cd native-chat-completions

pip install foundry-local-sdk-winl

If you are developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:

```bash

cd native-chat-completions

pip install foundry-local-sdk-winml

Copilot · 2026-04-01T17:16:23Z

samples/js/README.md

+   If you developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:
+
+   ```bash
+   cd native-chat-completions
+   npm install foundry-local-sdk-winl


The Windows install command uses foundry-local-sdk-winl, but the root README.md uses foundry-local-sdk-winml. This mismatch is likely a typo and will cause the documented command to fail. Please standardize on the correct package name throughout the repository.

Suggested change

If you developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:

```bash

cd native-chat-completions

npm install foundry-local-sdk-winl

If you are developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:

```bash

cd native-chat-completions

npm install foundry-local-sdk-winml

Copilot · 2026-04-01T17:16:23Z

samples/python/README.md

+
+2. Navigate to a sample and install dependencies:
+
+   If you developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:


Fix grammar: change 'If you developing' to 'If you are developing'.

Suggested change

If you developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:

If you are developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:

Copilot · 2026-04-01T17:16:23Z

samples/js/README.md

+
+2. Navigate to a sample and install dependencies:
+
+   If you developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:


Fix grammar: change 'If you developing' to 'If you are developing'.

Suggested change

If you developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:

If you are developing or shipping on **Windows**, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:

Copilot · 2026-04-01T17:16:24Z

README.md

+    messages = [
+        {"role": "user", "content": "What is the golden ratio?"}
+    ]
+    response = client.complete_chat(messages):


The Python quickstart snippet has a syntax error: the trailing : on the response = ... line will raise a SyntaxError, and print(...) will not be correctly indented/executed as intended. Please correct the call line so the snippet runs as pasted.

Suggested change

response = client.complete_chat(messages):

response = client.complete_chat(messages)

Copilot · 2026-04-01T17:16:24Z

samples/rust/README.md

+| Sample | Description |
+|--------|-------------|
+| [native-chat-completions](native-chat-completions/) | Non-streaming and streaming chat completions using the native chat client. |
+| [audio-transcription-example](audio-transcription-example/) | Audio transcription (non-streaming and streaming) using the Whisper model. |
+| [foundry-local-webserver](foundry-local-webserver/) | Start a local OpenAI-compatible web server and call it with a standard HTTP client. |
+| [tool-calling-foundry-local](tool-calling-foundry-local/) | Tool calling with streaming responses, multi-turn conversation, and local tool execution. |


The samples table markup currently starts with || in the diff (|| Sample | Description |), which renders as an extra empty column in GitHub Markdown. Use a single leading | for the header/separator/rows to render a 2-column table correctly.

Copilot · 2026-04-01T17:16:24Z

samples/python/README.md

+| Sample | Description |
+|--------|-------------|
+| [native-chat-completions](native-chat-completions/) | Initialize the SDK, start the local service, and run streaming chat completions. |
+| [audio-transcription](audio-transcription/) | Transcribe audio files using the Whisper model. |


The samples table markup currently starts with || in the diff, which renders as an unintended empty column in GitHub Markdown. Use a single leading | for the table header/separator/rows.

Copilot · 2026-04-01T17:16:24Z

samples/js/README.md

+| Sample | Description |
+|--------|-------------|
+| [native-chat-completions](native-chat-completions/) | Initialize the SDK, download a model, and run non-streaming and streaming chat completions. |
+| [audio-transcription-example](audio-transcription-example/) | Transcribe audio files using the Whisper model with streaming output. |


The samples table markup currently starts with || in the diff, which renders as an unintended empty column in GitHub Markdown. Use a single leading | for the table header/separator/rows.

Copilot · 2026-04-01T17:16:25Z

samples/rust/README.md

+   cd native-chat-completions
+   cargo run
+   ```
+>[!NOTE]


GitHub admonitions require a space after > (e.g., > [!NOTE]). As written (>[!NOTE]), it may not render as a note callout.

Suggested change

>[!NOTE]

> [!NOTE]

Copilot · 2026-04-01T17:16:25Z

samples/rust/README.md

+> If you are developing or shipping on **Windows**, you should update the sample's `Cargo.toml` file to include the WinML feature - this integrates with WinML to provide a greater breadth of hardware acceleration support.
+>
+> ```toml
+> foundry-local-sdk = { features = ["winml"] }


This TOML snippet is likely incomplete/misleading for users copying it into Cargo.toml: it omits at least the dependency version (and may replace an existing dependency line). Consider rephrasing to explicitly show modifying the existing foundry-local-sdk dependency entry (e.g., adding features = [\"winml\"] alongside the existing version), or include a placeholder version to avoid invalid cargo manifests.

Suggested change

> foundry-local-sdk = { features = ["winml"] }

> foundry-local-sdk = { version = "x.y.z", features = ["winml"] }

metang · 2026-04-02T03:46:20Z

samples/cs/README.md

 | [tutorial-document-summarizer](tutorial-document-summarizer/) | Summarize documents with AI (tutorial). |
 | [tutorial-tool-calling](tutorial-tool-calling/) | Create a tool-calling assistant (tutorial). |
 | [tutorial-voice-to-text](tutorial-voice-to-text/) | Transcribe and summarize audio (tutorial). |
+| [live-audio-transcription-example](live-audio-transcription-example/) | Real-time microphone-to-text transcription using NAudio (Windows). |


will this be ready by GA time. I assume once we have the sample ready, but the model is not ready, it may cause confusion.

metang

some comment

samuel100 and others added 2 commits April 1, 2026 15:24

readme init

56b0257

Copilot AI review requested due to automatic review settings April 1, 2026 17:09

samuel100 marked this pull request as draft April 1, 2026 17:09

Copilot AI reviewed Apr 1, 2026

View reviewed changes

Copilot started reviewing on behalf of samuel100 April 1, 2026 17:27 View session

metang reviewed Apr 2, 2026

View reviewed changes


		2. Navigate to a sample and install dependencies:

		If you developing or shipping on Windows, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:

	If you developing or shipping on Windows, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:
	If you are developing or shipping on Windows, use the Windows version - it has the same API surface area but integrates with WinML for a greater breadth of hardware acceleration:

	response = client.complete_chat(messages):
	response = client.complete_chat(messages)

	> foundry-local-sdk = { features = ["winml"] }
	> foundry-local-sdk = { version = "x.y.z", features = ["winml"] }

Conversation

samuel100 commented Apr 1, 2026

Uh oh!

vercel bot commented Apr 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

metang Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

metang left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants