Skip to content

Add JS and C# SDK API reference docs to www site#530

Draft
Copilot wants to merge 3 commits intomainfrom
copilot/add-api-reference-documentation
Draft

Add JS and C# SDK API reference docs to www site#530
Copilot wants to merge 3 commits intomainfrom
copilot/add-api-reference-documentation

Conversation

Copy link
Contributor

Copilot AI commented Mar 18, 2026

The www site had no API reference documentation for the JS or C# SDKs. This adds complete API docs for both language bindings, wired into the site's existing docs infrastructure.

Content

  • www/src/content/api-reference/index.md — Overview with architecture, core concepts, and side-by-side JS/C# comparison
  • www/src/content/api-reference/javascript.md — Full JS/TS SDK reference: FoundryLocalManager, Catalog, Model, ModelVariant, ChatClient, AudioClient, config, types, and end-to-end examples
  • www/src/content/api-reference/csharp.md — Full C#/.NET SDK reference: same class surface, plus ICatalog interface, IDisposable patterns, IAsyncEnumerable streaming, CancellationToken usage

All docs sourced from the auto-generated TypeDoc/xmldoc2md output in sdk_v2/js/docs/ and sdk_v2/cs/docs/api/, rewritten with consistent tables, inline examples, and structured headings for human and AI consumption.

Site changes

  • doc-renderer.svelte — Added csharp and python to shiki highlighter langs
  • config.ts — Added "API Reference" nav item pointing to /docs/api-reference

Navigation auto-generates from the www/src/content/ file tree, so the three new markdown files appear in the sidebar automatically.

Copilot AI and others added 3 commits March 18, 2026 00:14
…pport

Co-authored-by: baijumeswani <12852605+baijumeswani@users.noreply.github.com>
Co-authored-by: baijumeswani <12852605+baijumeswani@users.noreply.github.com>
@vercel
Copy link

vercel bot commented Mar 18, 2026

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

Project Deployment Actions Updated (UTC)
foundry-local Ready Ready Preview, Comment Mar 18, 2026 0:40am

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.

2 participants