[sdk_v2] updates js documentation

[prathikr]

JS SDK Documentation Updates

What Changed

README.md — Rewritten

Replaced the minimal quick start with a comprehensive, feature-focused guide:

• Features list at the top highlighting all SDK capabilities
• WinML section — prominent callout for --winml install flag and automatic EP management
• Usage sections for catalog browsing, model loading, chat completions, streaming, audio transcription, embedded web service, and configuration
• Fixed package name and removed stale docs/index.html references

typedoc.json — Added

New config controlling API doc generation: hides @internal exports, removes source links, renders params as tables, expands object types inline, and only generates per-class pages.

package.json — Updated docs script

Now reads from typedoc.json and strips the auto-generated index page (interfaces/enums already covered in README).

---

Result

README.md              ← Hand-written guide (edit directly)
docs/classes/*.md      ← Auto-generated per class (edit TSDoc in source, then npm run docs)

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
foundry-local	Ready	Preview, Comment	Feb 25, 2026 11:25pm

[Copilot]

Pull request overview

Updates the JS SDK’s documentation and API doc generation setup to provide a richer hand-written README and a slimmer, class-focused auto-generated Markdown reference.

Changes:

• Rewrites sdk_v2/js/README.md into a feature-focused guide with usage examples and links into generated class docs.
• Adds sdk_v2/js/typedoc.json and updates sdk_v2/js/package.json to generate docs via TypeDoc + typedoc-plugin-markdown.
• Removes previously generated TypeDoc pages for interfaces/enums/globals and refreshes the generated class Markdown under sdk_v2/js/docs/classes/.

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
sdk_v2/js/typedoc.json	Adds TypeDoc config for Markdown output and class-per-page generation.
sdk_v2/js/package.json	Simplifies docs script to run TypeDoc using config defaults.
sdk_v2/js/docs/interfaces/Runtime.md	Removes old generated interface page.
sdk_v2/js/docs/interfaces/PromptTemplate.md	Removes old generated interface page.
sdk_v2/js/docs/interfaces/Parameter.md	Removes old generated interface page.
sdk_v2/js/docs/interfaces/ModelSettings.md	Removes old generated interface page.
sdk_v2/js/docs/interfaces/ModelInfo.md	Removes old generated interface page.
sdk_v2/js/docs/interfaces/IModel.md	Removes old generated interface page.
sdk_v2/js/docs/interfaces/FoundryLocalConfig.md	Removes old generated interface page.
sdk_v2/js/docs/globals.md	Removes old generated globals index page.
sdk_v2/js/docs/enumerations/DeviceType.md	Removes old generated enum page.
sdk_v2/js/docs/classes/ModelVariant.md	Refreshes generated class docs formatting/links for ModelVariant.
sdk_v2/js/docs/classes/ModelLoadManager.md	Refreshes generated class docs formatting/links for ModelLoadManager.
sdk_v2/js/docs/classes/Model.md	Refreshes generated class docs formatting/links for Model.
sdk_v2/js/docs/classes/FoundryLocalManager.md	Refreshes generated class docs formatting/links for FoundryLocalManager.
sdk_v2/js/docs/classes/CoreInterop.md	Removes old generated internal class page.
sdk_v2/js/docs/classes/Configuration.md	Removes old generated internal class page.
sdk_v2/js/docs/classes/ChatClientSettings.md	Refreshes generated class docs formatting; hides internal members.
sdk_v2/js/docs/classes/ChatClient.md	Refreshes generated class docs formatting; hides internal ctor.
sdk_v2/js/docs/classes/Catalog.md	Refreshes generated class docs formatting/links for Catalog.
sdk_v2/js/docs/classes/AudioClientSettings.md	Refreshes generated class docs formatting; hides internal members.
sdk_v2/js/docs/classes/AudioClient.md	Refreshes generated class docs formatting; hides internal ctor.
sdk_v2/js/docs/README.md	Removes old generated docs index/README page.
sdk_v2/js/README.md	Replaces minimal quick start with a comprehensive guide and API reference links.

---

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

[Copilot]

Pull request overview

Copilot reviewed 26 out of 27 changed files in this pull request and generated 2 comments.

---

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

[Copilot]

Pull request overview

Copilot reviewed 27 out of 28 changed files in this pull request and generated 2 comments.

---

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

[Copilot]

Pull request overview

Copilot reviewed 27 out of 28 changed files in this pull request and generated no new comments.

---

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