Fix TypeScript documentation gaps#1204
Open
sebastienros wants to merge 4 commits into
Open
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
sebastienros
requested review from
IEvangelist,
aaronpowell and
eerhardt
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates aspire.dev documentation to close identified TypeScript AppHost coverage gaps by replacing “C#-only / not available in TypeScript” notes with supported TypeScript examples, and by adding TypeScript-oriented installation/config guidance for several Community Toolkit integrations (including aspire add + aspire.config.json).
Changes:
- Add TypeScript AppHost code samples (many twoslash-annotated) across “what’s new”, fundamentals, deployment, AppHost, and multiple integration reference pages.
- Add/adjust TypeScript installation guidance for Community Toolkit integrations using
aspire addandaspire.config.json. - Update Japanese docs to include TypeScript equivalents where the TypeScript SDK surface is now available.
Reviewed changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/whats-new/aspire-13-4.mdx | Adds a TypeScript tab/example for the highlighted feature in 13.4 release notes. |
| src/frontend/src/content/docs/ja/fundamentals/external-parameters.mdx | Replaces prior TS limitation note with a TS parameter example using description/custom input APIs. |
| src/frontend/src/content/docs/ja/deployment/pipelines.mdx | Adds a TypeScript pipeline step example (replacing C#-only note). |
| src/frontend/src/content/docs/ja/app-host/container-files.mdx | Adds TypeScript example for container files workflows. |
| src/frontend/src/content/docs/ja/app-host/certificate-configuration.mdx | Adds TypeScript examples for certificate configuration/trust sections. |
| src/frontend/src/content/docs/integrations/observability/seq/seq-host.mdx | Replaces TS guidance note with a TS example using volume + lifetime + EULA configuration. |
| src/frontend/src/content/docs/integrations/messaging/lavinmq.mdx | Adds TypeScript installation + usage examples for LavinMQ Community Toolkit integration. |
| src/frontend/src/content/docs/integrations/messaging/apache-kafka/apache-kafka-host.mdx | Replaces TS limitation note with a TS example using connection string resource approach. |
| src/frontend/src/content/docs/integrations/devtools/sql-projects.mdx | Adds TypeScript install + usage examples for SQL Database Projects (Toolkit). |
| src/frontend/src/content/docs/integrations/devtools/k6.mdx | Adds TypeScript install + usage examples (and updates guidance text to mention TS APIs). |
| src/frontend/src/content/docs/integrations/devtools/dab.mdx | Adds TypeScript install + usage examples for Data API Builder (Toolkit). |
| src/frontend/src/content/docs/integrations/databases/sql-server/sql-server-extensions.mdx | Adds TypeScript examples for DbGate/Adminer extensions and TS package guidance. |
| src/frontend/src/content/docs/integrations/databases/postgres/postgresql-extensions.mdx | Adds TypeScript examples for DbGate/Adminer extensions and TS package guidance. |
| src/frontend/src/content/docs/integrations/databases/mysql/mysql-host.mdx | Updates TypeScript example to use persistent lifetime + replaces prior TS limitation note. |
| src/frontend/src/content/docs/integrations/databases/mysql/mysql-extensions.mdx | Adds TypeScript examples for DbGate/Adminer extensions and TS package guidance. |
| src/frontend/src/content/docs/integrations/databases/mongodb/mongodb-extensions.mdx | Adds TypeScript example for DbGate extension and TS package guidance. |
| src/frontend/src/content/docs/integrations/compute/docker.mdx | Replaces TS limitation notes with TS examples for withImagePushOptions. |
| src/frontend/src/content/docs/integrations/cloud/azure/container-app-jobs.mdx | Replaces TS limitation note with TS scheduled job publish example. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-data-explorer.mdx | Replaces TS limitation note with TS example using withCreationScript. |
| src/frontend/src/content/docs/integrations/caching/redis-extensions.mdx | Adds TypeScript install + DbGate example for Redis extensions. |
| src/frontend/src/content/docs/integrations/ai/ollama/ollama-host.mdx | Replaces TS limitation note with TS example enabling Open WebUI. |
| src/frontend/src/content/docs/deployment/pipelines.mdx | Adds TypeScript pipeline step example (replacing C#-only note). |
| src/frontend/src/content/docs/deployment/docker-compose.mdx | Adds TypeScript example for withImagePushOptions in Docker Compose publishing. |
| src/frontend/src/content/docs/app-host/withdockerfile.mdx | Replaces TS limitation notes with TS examples using Dockerfile factory APIs. |
| src/frontend/src/content/docs/app-host/container-files.mdx | Adds TypeScript example for container files workflows. |
| src/frontend/src/content/docs/app-host/certificate-configuration.mdx | Adds TypeScript examples for certificate configuration/trust sections. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The additional TypeScript examples still render as TypeScript code blocks, but not through twoslash. This avoids the frontend production build exceeding the default Node heap while preserving existing twoslash coverage. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation