Skip to content

Samuel100/update readmes#573

Open
samuel100 wants to merge 10 commits intomainfrom
samuel100/update-readmes
Open

Samuel100/update readmes#573
samuel100 wants to merge 10 commits intomainfrom
samuel100/update-readmes

Conversation

@samuel100
Copy link
Copy Markdown
Contributor

Update README to better align the product offering.

Updated sample READMEs.

samuel100 and others added 2 commits April 1, 2026 15:24
- 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>
Copilot AI review requested due to automatic review settings April 1, 2026 17:09
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 1, 2026

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

Project Deployment Actions Updated (UTC)
foundry-local Ready Ready Preview, Comment Apr 8, 2026 10:49am

Request Review

@samuel100 samuel100 marked this pull request as draft April 1, 2026 17:09
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator

@metang metang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some comment

@samuel100 samuel100 marked this pull request as ready for review April 7, 2026 14:14
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.

3 participants