Skip to content

Comments

[sdk_v2] updates cs documentation#454

Open
prathikr wants to merge 1 commit intomainfrom
prathikrao/update-cs-docs
Open

[sdk_v2] updates cs documentation#454
prathikr wants to merge 1 commit intomainfrom
prathikrao/update-cs-docs

Conversation

@prathikr
Copy link
Contributor

C# SDK Docs Update Summary

What changed

README.md — Complete rewrite. The old README referenced non-existent v2 APIs (StartModelAsync, GetModelInfoAsync) and wrong build paths. New version is feature-focused with correct v2 API usage throughout.

Sections added: Features, Installation, WinML (top-level), Quick Start, Usage (Initialization, Catalog, Model Lifecycle, Chat Completions, Streaming, Chat Settings, Audio Transcription, Audio Settings, Web Service, Configuration table, Disposal), API Reference, Tests.

Microsoft.AI.Foundry.Local.csproj — Added <GenerateDocumentationFile>true</GenerateDocumentationFile> to emit XML docs at build time. Fixed a mismatched <param> tag on Model.SelectVariant (modelIdvariant) that became a build error with doc generation enabled.

GENERATE-DOCS.md — New file documenting how to regenerate the API reference markdown using xmldoc2md.

docs/api/*.md — 16 auto-generated API reference files from XML doc comments (all public types, internal Detail namespace excluded).

Files added

  • GENERATE-DOCS.md
  • docs/api/ (16 files)

Files modified

  • README.md
  • src/Microsoft.AI.Foundry.Local.csproj
  • src/Model.cs (param tag fix)

@vercel
Copy link

vercel bot commented Feb 23, 2026

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

Project Deployment Actions Updated (UTC)
foundry-local Ready Ready Preview, Comment Feb 23, 2026 9:51pm

Request Review

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.

1 participant