Skip to content

Comments

[sdk_v2] updates js documentation#453

Open
prathikr wants to merge 2 commits intomainfrom
prathikrao/update-js-docs
Open

[sdk_v2] updates js documentation#453
prathikr wants to merge 2 commits intomainfrom
prathikrao/update-js-docs

Conversation

@prathikr
Copy link
Contributor

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
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 8:43pm

Request Review

@prathikr prathikr changed the title [sdk_v2] updates documentation [sdk_v2] updates js documentation Feb 23, 2026
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